KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SCH_BITMAP Class Reference

Object to handle a bitmap image that can be inserted in a schematic. More...

#include <sch_bitmap.h>

Inheritance diagram for SCH_BITMAP:
SCH_ITEM EDA_ITEM KIGFX::VIEW_ITEM SERIALIZABLE INSPECTABLE

Public Types

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

Public Member Functions

 SCH_BITMAP (const VECTOR2I &pos=VECTOR2I(0, 0))
 
 SCH_BITMAP (const SCH_BITMAP &aSchBitmap)
 
SCH_BITMAPoperator= (const SCH_ITEM &aItem)
 
REFERENCE_IMAGEGetReferenceImage ()
 
const REFERENCE_IMAGEGetReferenceImage () const
 
int GetX () const
 
void SetX (int aX)
 
int GetY () const
 
void SetY (int aY)
 
wxString GetClass () const override
 Return the class name.
 
const BOX2I GetBoundingBox () const override
 Return the orthogonal bounding box of this object for display purposes.
 
virtual std::vector< int > ViewGetLayers () const override
 
void Move (const VECTOR2I &aMoveVector) override
 Move the item by aMoveVector to a new position.
 
bool IsMovableFromAnchorPoint () const override
 Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor.
 
void MirrorHorizontally (int aCenter) override
 Mirror item horizontally about aCenter.
 
void MirrorVertically (int aCenter) override
 Mirror item vertically about aCenter.
 
void Rotate (const VECTOR2I &aCenter, bool aRotateCCW) override
 Rotate the item around aCenter 90 degrees in the clockwise direction.
 
wxString GetItemDescription (UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
 Return a user-visible description string of this item.
 
BITMAPS GetMenuImage () const override
 Return a pointer to an image to be used in menus.
 
void GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
 Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
 
VECTOR2I GetPosition () const override
 
void SetPosition (const VECTOR2I &aPosition) override
 
bool HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const override
 Test if aPosition is inside or on the boundary of this item.
 
bool HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
 Test if aRect intersects this item.
 
bool HitTest (const SHAPE_LINE_CHAIN &aPoly, bool aContained) const override
 Test if aPoly intersects this item.
 
void Plot (PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed) override
 Plot the item to aPlotter.
 
EDA_ITEMClone () const override
 Create a duplicate of this item with linked list members set to NULL.
 
double Similarity (const SCH_ITEM &aOther) const override
 Return a measure of how likely the other object is to represent the same object.
 
bool operator== (const SCH_ITEM &aOther) const override
 
bool IsType (const std::vector< KICAD_T > &aScanTypes) const override
 Check whether the item is one of the listed types.
 
bool IsGroupableType () const
 
void SwapItemData (SCH_ITEM *aImage)
 Swap data between aItem and aImage.
 
void SwapFlags (SCH_ITEM *aItem)
 Swap the non-temp and non-edit flags.
 
SCH_ITEMDuplicate (bool addToParentGroup, SCH_COMMIT *aCommit=nullptr, bool doClone=false) const
 Routine to create a new copy of given item.
 
virtual void SetUnit (int aUnit)
 
int GetUnit () const
 
virtual wxString GetUnitDisplayName (int aUnit, bool aLabel) const
 
virtual wxString GetBodyStyleDescription (int aBodyStyle, bool aLabel) const
 
virtual void SetBodyStyle (int aBodyStyle)
 
int GetBodyStyle () const
 
virtual void SetBodyStyleProp (const wxString &aBodyStyle)
 
virtual wxString GetBodyStyleProp () const
 
void SetPrivate (bool aPrivate)
 
bool IsPrivate () const
 
virtual void SetExcludedFromSim (bool aExclude)
 
virtual bool GetExcludedFromSim () const
 
bool ResolveExcludedFromSim () const
 
virtual void SetExcludedFromBOM (bool aExcludeFromBOM)
 
virtual bool GetExcludedFromBOM () const
 
bool ResolveExcludedFromBOM () const
 
virtual void SetExcludedFromBoard (bool aExcludeFromBoard)
 
virtual bool GetExcludedFromBoard () const
 
bool ResolveExcludedFromBoard () const
 
virtual void SetDNP (bool aDNP)
 
virtual bool GetDNP () const
 
bool ResolveDNP () const
 
VECTOR2IGetStoredPos ()
 
void SetStoredPos (const VECTOR2I &aPos)
 
SCHEMATICSchematic () const
 Search the item hierarchy to find a SCHEMATIC.
 
const SYMBOLGetParentSymbol () const
 
SYMBOLGetParentSymbol ()
 
virtual bool IsHypertext () const
 Allow items to support hypertext actions when hovered/clicked.
 
virtual void DoHypertextAction (EDA_DRAW_FRAME *aFrame) const
 
SCH_LAYER_ID GetLayer () const
 Return the layer this item is on.
 
void SetLayer (SCH_LAYER_ID aLayer)
 
virtual int GetPenWidth () const
 
int GetEffectivePenWidth (const SCH_RENDER_SETTINGS *aSettings) const
 
const wxString & GetDefaultFont (const RENDER_SETTINGS *aSettings) const
 
const KIFONT::METRICSGetFontMetrics () const
 
bool RenderAsBitmap (double aWorldScale) const override
 
double SimilarityBase (const SCH_ITEM &aItem) const
 Calculate the boilerplate similarity for all LIB_ITEMs without preventing the use above of a pure virtual function that catches at compile time when a new object has not been fully implemented.
 
virtual void BeginEdit (const VECTOR2I &aPosition)
 Begin drawing a symbol library draw item at aPosition.
 
virtual bool ContinueEdit (const VECTOR2I &aPosition)
 Continue an edit in progress at aPosition.
 
virtual void EndEdit (bool aClosed=false)
 End an object editing action.
 
virtual void CalcEdit (const VECTOR2I &aPosition)
 Calculate the attributes of an item at aPosition when it is being edited.
 
virtual void GetEndPoints (std::vector< DANGLING_END_ITEM > &aItemList)
 Add the schematic item end points to aItemList if the item has end points.
 
virtual bool UpdateDanglingState (std::vector< DANGLING_END_ITEM > &aItemListByType, std::vector< DANGLING_END_ITEM > &aItemListByPos, const SCH_SHEET_PATH *aSheet=nullptr)
 Test the schematic item to aItemList to check if it's dangling state has changed.
 
virtual bool IsEndPoint (const VECTOR2I &aPt) const
 Test if aPt is an end point of this schematic object.
 
virtual bool IsDangling () const
 
virtual bool CanConnect (const SCH_ITEM *aItem) const
 
virtual bool IsConnectable () const
 
virtual bool IsPointClickableAnchor (const VECTOR2I &aPos) const
 
virtual std::vector< VECTOR2IGetConnectionPoints () const
 Add all the connection points for this item to aPoints.
 
bool IsConnected (const VECTOR2I &aPoint) const
 Test the item to see if it is connected to aPoint.
 
SCH_CONNECTIONConnection (const SCH_SHEET_PATH *aSheet=nullptr) const
 Retrieve the connection associated with this object in the given sheet.
 
const SCH_ITEM_VECConnectedItems (const SCH_SHEET_PATH &aPath)
 Retrieve the set of items connected to this item on the given sheet.
 
void AddConnectionTo (const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
 Add a connection link between this item and another.
 
void ClearConnectedItems (const SCH_SHEET_PATH &aPath)
 Clear all connections to this item.
 
SCH_CONNECTIONInitializeConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 Create a new connection object associated with this object.
 
SCH_CONNECTIONGetOrInitConnection (const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
 
virtual bool ConnectionPropagatesTo (const EDA_ITEM *aItem) const
 Return true if this item should propagate connection info to aItem.
 
bool IsConnectivityDirty () const
 
void SetConnectivityDirty (bool aDirty=true)
 
virtual bool HasConnectivityChanges (const SCH_ITEM *aItem, const SCH_SHEET_PATH *aInstance=nullptr) const
 Check if aItem has connectivity changes against this object.
 
void SetConnectionGraph (CONNECTION_GRAPH *aGraph)
 Update the connection graph for all connections in this item.
 
virtual bool HasCachedDriverName () const
 
virtual const wxString & GetCachedDriverName () const
 
virtual void SetLastResolvedState (const SCH_ITEM *aItem)
 
std::shared_ptr< NETCLASSGetEffectiveNetClass (const SCH_SHEET_PATH *aSheet=nullptr) const
 
AUTOPLACE_ALGO GetFieldsAutoplaced () const
 Return whether the fields have been automatically placed.
 
void SetFieldsAutoplaced (AUTOPLACE_ALGO aAlgo)
 
virtual void AutoplaceFields (SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo)
 
virtual void RunOnChildren (const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode)
 
virtual void ClearCaches ()
 
virtual bool HasLineStroke () const
 Check if this schematic item has line stoke properties.
 
virtual STROKE_PARAMS GetStroke () const
 
virtual void SetStroke (const STROKE_PARAMS &aStroke)
 
void ClearRuleAreasCache ()
 Reset the cache of rule areas (called prior to schematic connectivity computation)
 
void AddRuleAreaToCache (SCH_RULE_AREA *aRuleArea)
 Add a rule area to the item's cache.
 
const std::unordered_set< SCH_RULE_AREA * > & GetRuleAreaCache () const
 Get the cache of rule areas enclosing this item.
 
const std::vector< wxString > * GetEmbeddedFonts () override
 
virtual bool operator< (const SCH_ITEM &aItem) const
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object.
 
KICAD_T Type () const
 Returns the type of object.
 
EDA_ITEMGetParent () const
 
virtual void SetParent (EDA_ITEM *aParent)
 
virtual void SetParentGroup (EDA_GROUP *aGroup)
 
virtual EDA_GROUPGetParentGroup () const
 
KIID GetParentGroupId () const
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsSelected () const
 
bool IsEntered () const
 
bool IsBrightened () const
 
bool IsRollover () const
 
void SetIsRollover (bool aIsRollover)
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
void SetFlags (EDA_ITEM_FLAGS aMask)
 
void XorFlags (EDA_ITEM_FLAGS aMask)
 
void ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
EDA_ITEM_FLAGS GetFlags () const
 
bool HasFlag (EDA_ITEM_FLAGS aFlag) const
 
EDA_ITEM_FLAGS GetEditFlags () const
 
virtual void ClearEditFlags ()
 
EDA_ITEM_FLAGS GetTempFlags () const
 
virtual void ClearTempFlags ()
 
void SetIsShownAsBitmap (bool aBitmap)
 
bool IsShownAsBitmap () const
 
void SetForceVisible (bool aEnable)
 Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.
 
bool IsForceVisible () const
 
virtual wxString GetFriendlyName () const
 
virtual const VECTOR2I GetFocusPosition () const
 Similar to GetPosition() but allows items to return their visual center rather than their anchor.
 
virtual VECTOR2I GetSortPosition () const
 Return the coordinates that should be used for sorting this element visually compared to other elements.
 
virtual INSPECT_RESULT Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
 May be re-implemented for each derived class in order to handle all the types given by its member data.
 
wxString GetTypeDesc () const
 Return a translated description of the type for this EDA_ITEM for display in user facing messages.
 
virtual bool Matches (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
 Compare the item against the search criteria in aSearchData.
 
virtual bool Replace (const EDA_SEARCH_DATA &aSearchData, void *aAuxData=nullptr)
 Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.
 
virtual bool IsReplaceable () const
 Override this method in any derived object that supports test find and replace.
 
virtual const BOX2I ViewBBox () const override
 Return the bounding box of the item covering all its layers.
 
virtual EMBEDDED_FILESGetEmbeddedFiles ()
 
bool IsSCH_ITEM () const
 
bool IsBOARD_ITEM () const
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer.
 
virtual double ViewGetLOD (int aLayer, const VIEW *aView) const
 Return the level of detail (LOD) of the item.
 
VIEW_ITEM_DATA * viewPrivData () const
 
void SetForcedTransparency (double aForcedTransparency)
 
double GetForcedTransparency () const
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue, bool aNotify=true)
 
template<typename T>
bool Set (PROPERTY_BASE *aProperty, T aValue, bool aNotify=true)
 
bool Set (PROPERTY_BASE *aProperty, wxVariant aValue, bool aNotify=true)
 
template<typename T>
bool Set (const wxString &aProperty, T aValue, bool aNotify=true)
 
wxAny Get (PROPERTY_BASE *aProperty) const
 
template<typename T>
T Get (PROPERTY_BASE *aProperty) const
 
template<typename T>
std::optional< TGet (const wxString &aProperty) const
 
virtual void Serialize (google::protobuf::Any &aContainer) const
 Serializes this object to the given Any message.
 
virtual bool Deserialize (const google::protobuf::Any &aContainer)
 Deserializes the given protobuf message into this object.
 

Static Public Member Functions

static bool ClassOf (const EDA_ITEM *aItem)
 
template<class T>
static INSPECT_RESULT IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
 This changes first parameter to avoid the DList and use the main queue instead.
 
template<class T>
static INSPECT_RESULT IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
 Change first parameter to avoid the DList and use std::vector instead.
 
static bool Replace (const EDA_SEARCH_DATA &aSearchData, wxString &aText)
 Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.
 
static bool Sort (const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
 Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.
 

Public Attributes

const KIID m_Uuid
 

Protected Member Functions

void swapData (SCH_ITEM *aItem) override
 Swap the internal data structures aItem with the schematic item.
 
SCH_RENDER_SETTINGSgetRenderSettings (PLOTTER *aPlotter) const
 
virtual int compare (const SCH_ITEM &aOther, int aCompareFlags=0) const
 Provide the draw object specific comparison called by the == and < operators.
 
bool Matches (const wxString &aText, const EDA_SEARCH_DATA &aSearchData) const
 Compare aText against search criteria in aSearchData.
 
EDA_ITEMfindParent (KICAD_T aType) const
 

Static Protected Member Functions

static double lodScaleForThreshold (const KIGFX::VIEW *aView, int aWhatIu, int aThresholdIu)
 Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.
 

Protected Attributes

SCH_LAYER_ID m_layer
 
int m_unit
 
int m_bodyStyle
 
bool m_private
 
AUTOPLACE_ALGO m_fieldsAutoplaced
 
VECTOR2I m_storedPos
 
std::map< SCH_SHEET_PATH, SCH_ITEM_VEC, SHEET_PATH_CMPm_connected_items
 Store pointers to other items that are connected to this one, per sheet.
 
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
 Store connectivity information, per sheet.
 
bool m_connectivity_dirty
 
std::unordered_set< SCH_RULE_AREA * > m_rule_areas_cache
 Store pointers to rule areas which this item is contained within.
 
EDA_ITEM_FLAGS m_flags
 
EDA_ITEMm_parent
 Owner.
 
EDA_GROUPm_group
 The group this item belongs to, if any. No ownership implied.
 
bool m_forceVisible
 
bool m_isRollover
 

Static Protected Attributes

static constexpr double LOD_HIDE = std::numeric_limits<double>::max()
 Return this constant from ViewGetLOD() to hide the item unconditionally.
 
static constexpr double LOD_SHOW = 0.0
 Return this constant from ViewGetLOD() to show the item unconditionally.
 

Private Member Functions

int GetWidth () const
 
void SetWidth (int aWidth)
 
int GetHeight () const
 
void SetHeight (int aHeight)
 
int GetTransformOriginOffsetX () const
 
void SetTransformOriginOffsetX (int aX)
 
int GetTransformOriginOffsetY () const
 
void SetTransformOriginOffsetY (int aY)
 
double GetImageScale () const
 
void SetImageScale (double aScale)
 
virtual bool doIsConnected (const VECTOR2I &aPosition) const
 Provide the object specific test to see if it is connected to aPosition.
 

Private Attributes

REFERENCE_IMAGE m_referenceImage
 
KICAD_T m_structType
 Run time identification, keep private so it can never be changed after a ctor sets it.
 
bool m_isSCH_ITEM
 
bool m_isBOARD_ITEM
 
VIEW_ITEM_DATA * m_viewPrivData
 
double m_forcedTransparency
 Additional transparency for diff'ing items.
 

Friends

struct SCH_BITMAP_DESC
 

Detailed Description

Object to handle a bitmap image that can be inserted in a schematic.

Definition at line 39 of file sch_bitmap.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum SCH_ITEM::COMPARE_FLAGS : int
inherited

The list of flags used by the compare function.

UNIT This flag relaxes unit, body-style and pin-number constraints. It is used for SCH_ITEM object unit comparisons.

EQUALITY This flag relaxes ordering constraints so that fields, etc. don't have to appear in the same order to be considered equal.

ERC This flag relaxes constraints on data that is settable in the schematic editor. It compares only symbol-editor-only data.

SKIP_TST_POS This flag relaxes comparisons on position (mainly for fields) for ERC.

Enumerator
UNIT 
EQUALITY 
ERC 
SKIP_TST_POS 

Definition at line 666 of file sch_item.h.

Constructor & Destructor Documentation

◆ SCH_BITMAP() [1/2]

SCH_BITMAP::SCH_BITMAP ( const VECTOR2I & pos = VECTOR2I( 0, 0 ))

◆ SCH_BITMAP() [2/2]

SCH_BITMAP::SCH_BITMAP ( const SCH_BITMAP & aSchBitmap)

Definition at line 55 of file sch_bitmap.cpp.

References m_referenceImage, SCH_BITMAP(), and SCH_ITEM::SCH_ITEM().

Member Function Documentation

◆ AddConnectionTo()

void SCH_ITEM::AddConnectionTo ( const SCH_SHEET_PATH & aPath,
SCH_ITEM * aItem )
inherited

Add a connection link between this item and another.

Definition at line 388 of file sch_item.cpp.

References m_connected_items, and SCH_ITEM().

Referenced by SCH_LABEL_BASE::UpdateDanglingState(), and CONNECTION_GRAPH::updateItemConnectivity().

◆ AddRuleAreaToCache()

void SCH_ITEM::AddRuleAreaToCache ( SCH_RULE_AREA * aRuleArea)
inlineinherited

Add a rule area to the item's cache.

Definition at line 640 of file sch_item.h.

References m_rule_areas_cache.

Referenced by SCH_RULE_AREA::addContainedItem().

◆ AutoplaceFields()

◆ BeginEdit()

virtual void SCH_ITEM::BeginEdit ( const VECTOR2I & aPosition)
inlinevirtualinherited

Begin drawing a symbol library draw item at aPosition.

It typically would be called on a left click when a draw tool is selected in the symbol library editor and one of the graphics tools is selected.

Parameters
aPositionThe position in drawing coordinates where the drawing was started. May or may not be required depending on the item being drawn.

Reimplemented in SCH_FIELD, SCH_SHAPE, and SCH_TEXT.

Definition at line 403 of file sch_item.h.

◆ CalcEdit()

virtual void SCH_ITEM::CalcEdit ( const VECTOR2I & aPosition)
inlinevirtualinherited

Calculate the attributes of an item at aPosition when it is being edited.

This method gets called by the Draw() method when the item is being edited. This probably should be a pure virtual method but bezier curves are not yet editable in the symbol library editor. Therefore, the default method does nothing.

Parameters
aPositionThe current mouse position in drawing coordinates.

Reimplemented in SCH_FIELD, SCH_PIN, SCH_SHAPE, and SCH_TEXT.

Definition at line 433 of file sch_item.h.

◆ CanConnect()

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

◆ ClassOf()

static bool SCH_BITMAP::ClassOf ( const EDA_ITEM * aItem)
inlinestatic

Definition at line 60 of file sch_bitmap.h.

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

◆ ClearBrightened()

◆ ClearCaches()

void SCH_ITEM::ClearCaches ( )
virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 497 of file sch_item.cpp.

References NO_RECURSE, RunOnChildren(), SCH_ITEM(), and text.

◆ ClearConnectedItems()

void SCH_ITEM::ClearConnectedItems ( const SCH_SHEET_PATH & aPath)
inherited

◆ ClearEditFlags()

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS)
inlineinherited

Definition at line 144 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, and m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), SCH_MOVE_TOOL::AlignToGrid(), PCB_CONTROL::ApplyDesignBlockLayout(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), ClearBrightened(), ClearEditFlags(), ClearSelected(), ClearTempFlags(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_EDIT_FRAME::ExchangeFootprint(), SCH_IO_KICAD_SEXPR::Format(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), PAD::Recombine(), GERBVIEW_FRAME::RemapLayers(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_SELECTION_TOOL::SelectMultiple(), SetIsShownAsBitmap(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_SELECTION_TOOL::unhighlight(), and SCOPED_FLAGS_CLEANER::~SCOPED_FLAGS_CLEANER().

◆ ClearRuleAreasCache()

void SCH_ITEM::ClearRuleAreasCache ( )
inlineinherited

Reset the cache of rule areas (called prior to schematic connectivity computation)

Definition at line 635 of file sch_item.h.

References m_rule_areas_cache.

◆ ClearSelected()

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )
inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 169 of file eda_item.h.

References ClearFlags(), and GetTempFlags().

Referenced by LIB_SYMBOL::ClearTempFlags(), SCH_EDIT_FRAME::PutDataInPreviousState(), and SCH_ITEM::SwapFlags().

◆ Clone()

EDA_ITEM * SCH_BITMAP::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 80 of file sch_bitmap.cpp.

References EDA_ITEM::EDA_ITEM(), and SCH_BITMAP().

◆ compare()

int SCH_ITEM::compare ( const SCH_ITEM & aOther,
int aCompareFlags = 0 ) const
protectedvirtualinherited

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 SCH_ITEM::compare before doing any derived object comparisons or you will break the sorting using the symbol library file format.
Parameters
aOtherA reference to the other SCH_ITEM to compare the arc against.
aCompareFlagsThe 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.

Reimplemented in LIB_SYMBOL, SCH_FIELD, SCH_PIN, SCH_SHAPE, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 541 of file sch_item.cpp.

References EQUALITY, ERC, EDA_ITEM::GetPosition(), IsPrivate(), m_bodyStyle, m_unit, EDA_ITEM::m_Uuid, SCH_ITEM(), SKIP_TST_POS, EDA_ITEM::Type(), UNIT, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_FIELD::compare(), SCH_PIN::compare(), SCH_SHAPE::compare(), SCH_TEXT::compare(), SCH_ITEM::cmp_items::operator()(), operator<(), and operator==().

◆ ConnectedItems()

const SCH_ITEM_VEC & SCH_ITEM::ConnectedItems ( const SCH_SHEET_PATH & aPath)
inherited

Retrieve the set of items connected to this item on the given sheet.

Definition at line 382 of file sch_item.cpp.

References m_connected_items.

Referenced by addConnections(), BOOST_FIXTURE_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_symbol_connectivity, and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ Connection()

SCH_CONNECTION * SCH_ITEM::Connection ( const SCH_SHEET_PATH * aSheet = nullptr) const
inherited

◆ ConnectionPropagatesTo()

virtual bool SCH_ITEM::ConnectionPropagatesTo ( const EDA_ITEM * aItem) const
inlinevirtualinherited

Return true if this item should propagate connection info to aItem.

Reimplemented in SCH_BUS_WIRE_ENTRY, SCH_LINE, and SCH_PIN.

Definition at line 552 of file sch_item.h.

References EDA_ITEM::EDA_ITEM().

◆ ContinueEdit()

virtual bool SCH_ITEM::ContinueEdit ( const VECTOR2I & aPosition)
inlinevirtualinherited

Continue an edit in progress at aPosition.

This is used to perform the next action while drawing an item. This would be called for each additional left click when the mouse is captured while the item is being drawn.

Parameters
aPositionThe position of the mouse left click in drawing coordinates.
Returns
True if additional mouse clicks are required to complete the edit in progress.

Reimplemented in SCH_SHAPE.

Definition at line 415 of file sch_item.h.

◆ Deserialize()

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

Deserializes the given protobuf message into this object.

Parameters
aContaineris an Any which should have a concrete type matching this object
Returns
true if unpacking and deserialization succeeded

Reimplemented in BOARD_STACKUP, EDA_SHAPE, EDA_TEXT, FOOTPRINT, NETCLASS, PAD, PADSTACK, PCB_ARC, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GROUP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, and ZONE.

Definition at line 30 of file serializable.cpp.

Referenced by ~SERIALIZABLE().

◆ DoHypertextAction()

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

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 304 of file sch_item.h.

◆ doIsConnected()

virtual bool SCH_ITEM::doIsConnected ( const VECTOR2I & aPosition) const
inlineprivatevirtualinherited

Provide the object specific test to see if it is connected to aPosition.

Note
Override this function if the derived object can be connect to another object such as a wire, bus, or junction. Do not override this function for objects that cannot have connections. The default will always return false. This functions is call through the public function IsConnected() which performs tests common to all schematic items before calling the item specific connection testing.
Parameters
aPositionis a reference to a VECTOR2I object containing the test position.
Returns
True if connection to aPosition exists.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_JUNCTION, SCH_LABEL, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 736 of file sch_item.h.

Referenced by IsConnected().

◆ Duplicate()

SCH_ITEM * SCH_ITEM::Duplicate ( bool addToParentGroup,
SCH_COMMIT * aCommit = nullptr,
bool doClone = false ) const
inherited

Routine to create a new copy of given item.

The new object is not put in draw list (not linked).

Parameters
addToParentGroupIndicates whether or not the new item is added to the group (if any) containing the old item. If true, aCommit must be provided.
aDoClone(default = false) indicates unique values (such as timestamp and sheet name) should be duplicated. Use only for undo/redo operations.

Definition at line 137 of file sch_item.cpp.

References BRIGHTENED, EDA_ITEM::ClearFlags(), EDA_ITEM::Clone(), EDA_ITEM::GetParentGroup(), group, EDA_ITEM::m_Uuid, COMMIT::Modify(), NO_RECURSE, RunOnChildren(), SCH_ITEM(), and SELECTED.

Referenced by SCH_EDIT_FRAME::AddCopyForRepeatItem(), SCH_LINE::BreakAt(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_GROUP::DeepDuplicate(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), CADSTAR_SCH_ARCHIVE_LOADER::loadItemOntoKiCadSheet(), SCH_IO_EAGLE::loadSchematic(), SCH_LINE::NonGroupAware_BreakAt(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SaveCopyInUndoList(), and SCH_LINE_WIRE_BUS_TOOL::startSegments().

◆ EndEdit()

virtual void SCH_ITEM::EndEdit ( bool aClosed = false)
inlinevirtualinherited

End an object editing action.

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

Reimplemented in SCH_SHAPE.

Definition at line 422 of file sch_item.h.

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType) const
protectedinherited

◆ Get() [1/3]

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

◆ Get() [2/3]

◆ Get() [3/3]

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

◆ GetBodyStyle()

int SCH_ITEM::GetBodyStyle ( ) const
inlineinherited

Definition at line 244 of file sch_item.h.

References m_bodyStyle.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_PIN::Clone(), SCH_EDIT_TOOL::CycleBodyStyle(), SCH_INSPECTION_TOOL::DiffSymbol(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_SYMBOL::doIsConnected(), SCH_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), PIN_INFO_FORMATTER::Format(), SCH_SYMBOL::GetBodyStyleProp(), SCH_SYMBOL::GetConnectionPoints(), GetMsgPanelInfo(), SCH_SYMBOL::GetPin(), SCH_COLLECTOR::Inspect(), SCH_SYMBOL::IsPointClickableAnchor(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SCH_SELECTION_TOOL::Main(), SCH_SYMBOL::operator==(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), SCH_EDIT_TOOL::Properties(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveBezier(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveCircle(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePin(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveRectangle(), SCH_IO_KICAD_LEGACY::saveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SCH_SELECTION_TOOL::Selectable(), SCH_EDIT_FRAME::SelectBodyStyle(), sort_by_pin_number(), ERC_TESTER::TestMissingUnits(), BODY_STYLE_MENU::update(), and SCH_SYMBOL::Visit().

◆ GetBodyStyleDescription()

wxString SCH_ITEM::GetBodyStyleDescription ( int aBodyStyle,
bool aLabel ) const
virtualinherited

Reimplemented in LIB_SYMBOL, and SCH_SYMBOL.

Definition at line 179 of file sch_item.cpp.

References _, _HKI, and GetParentSymbol().

Referenced by PIN_INFO_FORMATTER::Format(), GetBodyStyleProp(), GetMsgPanelInfo(), and PIN_INFO_FORMATTER::UpdatePin().

◆ GetBodyStyleProp()

wxString SCH_ITEM::GetBodyStyleProp ( ) const
virtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 211 of file sch_item.cpp.

References GetBodyStyleDescription(), and m_bodyStyle.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ GetBoundingBox()

const BOX2I SCH_BITMAP::GetBoundingBox ( ) const
overridevirtual

Return the orthogonal bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Reimplemented from EDA_ITEM.

Definition at line 97 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by HitTest(), HitTest(), and HitTest().

◆ GetCachedDriverName()

const wxString & SCH_ITEM::GetCachedDriverName ( ) const
virtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 443 of file sch_item.cpp.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ GetClass()

wxString SCH_BITMAP::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Implements KIGFX::VIEW_ITEM.

Definition at line 65 of file sch_bitmap.h.

Referenced by operator=().

◆ GetConnectionPoints()

virtual std::vector< VECTOR2I > SCH_ITEM::GetConnectionPoints ( ) const
inlinevirtualinherited

Add all the connection points for this item to aPoints.

Not all schematic items have connection points so the default method does nothing.

Parameters
aPointsis the list of connection points to add to.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 508 of file sch_item.h.

Referenced by SCH_MOVE_TOOL::AlignToGrid(), EE_GRID_HELPER::computeAnchors(), SCH_EDIT_TOOL::DoDelete(), SCH_MOVE_TOOL::doMoveSelection(), SCH_SCREEN::GetNeededJunctions(), SCH_EDITOR_CONTROL::Paste(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), and CONNECTION_GRAPH::updateGenericItemConnectivity().

◆ GetDefaultFont()

const wxString & SCH_ITEM::GetDefaultFont ( const RENDER_SETTINGS * aSettings) const
inherited

◆ GetDNP()

virtual bool SCH_ITEM::GetDNP ( ) const
inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 265 of file sch_item.h.

Referenced by ResolveDNP().

◆ GetEditFlags()

◆ GetEffectiveNetClass()

◆ GetEffectivePenWidth()

◆ GetEmbeddedFiles()

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )
inlinevirtualinherited

Reimplemented in BOARD, FOOTPRINT, LIB_SYMBOL, SCH_SYMBOL, and SCHEMATIC.

Definition at line 468 of file eda_item.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::Parse().

◆ GetEmbeddedFonts()

const std::vector< wxString > * SCH_ITEM::GetEmbeddedFonts ( )
overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 655 of file sch_item.cpp.

References GetParentSymbol(), and Schematic().

◆ GetEndPoints()

virtual void SCH_ITEM::GetEndPoints ( std::vector< DANGLING_END_ITEM > & aItemList)
inlinevirtualinherited

Add the schematic item end points to aItemList if the item has end points.

The default version doesn't do anything since many of the schematic object cannot be tested for dangling ends. If you add a new schematic item that can have a dangling end ( no connect ), override this method to provide the correct end points.

Parameters
aItemListis the list of DANGLING_END_ITEMS to add to.

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

Definition at line 445 of file sch_item.h.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ GetExcludedFromBoard()

virtual bool SCH_ITEM::GetExcludedFromBoard ( ) const
inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 261 of file sch_item.h.

Referenced by ResolveExcludedFromBoard().

◆ GetExcludedFromBOM()

virtual bool SCH_ITEM::GetExcludedFromBOM ( ) const
inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 257 of file sch_item.h.

Referenced by ResolveExcludedFromBOM().

◆ GetExcludedFromSim()

virtual bool SCH_ITEM::GetExcludedFromSim ( ) const
inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, SCH_TEXT, SCH_TEXTBOX, and SYMBOL.

Definition at line 253 of file sch_item.h.

Referenced by ResolveExcludedFromSim().

◆ GetFieldsAutoplaced()

AUTOPLACE_ALGO SCH_ITEM::GetFieldsAutoplaced ( ) const
inlineinherited

◆ GetFlags()

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const
inlinevirtualinherited

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

Reimplemented in BOARD, PCB_ARC, PCB_SHAPE, and PCB_TRACK.

Definition at line 279 of file eda_item.h.

References GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), and test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run().

◆ GetFontMetrics()

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const
inlineinherited

◆ GetFriendlyName()

◆ GetHeight()

int SCH_BITMAP::GetHeight ( ) const
private

Definition at line 286 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ GetImageScale()

double SCH_BITMAP::GetImageScale ( ) const
private

Definition at line 262 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ GetItemDescription()

wxString SCH_BITMAP::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider,
bool aFull ) const
inlineoverridevirtual

Return a user-visible description string of this item.

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

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

Parameters
aLongindicates a long string is acceptable
Returns
The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 89 of file sch_bitmap.h.

References _.

◆ GetLayer()

SCH_LAYER_ID SCH_ITEM::GetLayer ( ) const
inlineinherited

Return the layer this item is on.

Definition at line 309 of file sch_item.h.

References m_layer.

Referenced by JUNCTION_HELPERS::AnalyzePoint(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), SCH_SYMBOL::CanConnect(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckDanglingWireEndpoints(), CONNECTION_GRAPH::ercCheckFloatingWires(), SCH_LINE::GetFriendlyName(), SCH_BUS_ENTRY_BASE::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), GetNetNavigatorItemText(), SCH_LINE::IsBus(), SCH_LINE::IsGraphicLine(), SCH_LINE::IsWire(), SCH_SCREEN::MarkConnections(), SCH_LINE::MergeOverlap(), SCH_BUS_ENTRY_BASE::operator<(), SCH_JUNCTION::operator<(), SCH_LINE::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), SCH_BUS_ENTRY_BASE::operator==(), SCH_LINE::operator==(), SCH_TEXT::operator==(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LINE::Plot(), SCH_SCREEN::Plot(), SCH_IO_KICAD_LEGACY::saveBusEntry(), SCH_IO_KICAD_LEGACY::saveLine(), SCH_IO_KICAD_SEXPR::saveLine(), SCH_IO_KICAD_LEGACY::saveText(), SCH_LINE::Serialize(), SCH_BUS_ENTRY_BASE::Similarity(), SCH_LINE::Similarity(), SCH_TEXT::Similarity(), SCH_EDIT_FRAME::TrimWire(), CONNECTION_GRAPH::updateGenericItemConnectivity(), CONNECTION_GRAPH::updateItemConnectivity(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetMenuImage()

BITMAPS SCH_BITMAP::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 183 of file sch_bitmap.cpp.

References image.

◆ GetMsgPanelInfo()

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

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

Parameters
aFrameis the EDA_DRAW_FRAME that displays the message panel
aListis the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 189 of file sch_bitmap.cpp.

References _, m_referenceImage, and UNITS_PROVIDER::MessageTextFromValue().

◆ GetOrInitConnection()

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

◆ GetParent()

EDA_ITEM * EDA_ITEM::GetParent ( ) const
inlineinherited

Definition at line 112 of file eda_item.h.

References EDA_ITEM(), and m_parent.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), findParent(), SCH_IO_KICAD_SEXPR::Format(), getClosestGroup(), SCH_TABLECELL::GetColumn(), SCH_TABLECELL::GetColumnWidth(), SCH_ITEM::GetEffectivePenWidth(), SCH_FIELD::GetFieldColor(), getInferredSymbols(), SCH_TABLECELL::GetParentGroup(), SCH_TABLECELL::GetRow(), SCH_TABLECELL::GetRowHeight(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_SELECTION_TOOL::highlight(), highlightNet(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), SCH_EDIT_TOOL::JustifyText(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_SELECTION_TOOL::Main(), SCH_EDIT_TOOL::Mirror(), SCH_MOVE_TOOL::moveItem(), SCH_EDIT_FRAME::onNetNavigatorSelection(), SCH_FIELD::OnScintillaCharAdded(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_BASE_FRAME::RefreshZoomDependentItems(), SCH_SELECTION_TOOL::RequestSelection(), SCH_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCHEMATIC::SCHEMATIC(), SCH_SCREEN::Schematic(), SCH_SHEET::SearchHierarchy(), PCB_SELECTION_TOOL::select(), SCH_MARKER::SerializeToString(), SCH_TABLECELL::SetColumnWidth(), SCH_LABEL_BASE::SetLabelShape(), SCH_TABLECELL::SetRowHeight(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), SCH_ITEM::SwapItemData(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), BOARD_COMMIT::undoLevelItem(), SCH_COMMIT::undoLevelItem(), SCH_SELECTION_TOOL::unhighlight(), KIGFX::SCH_VIEW::Update(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_BASE_FRAME::UpdateItem(), SCH_PROPERTIES_PANEL::valueChanged(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetParentGroup()

◆ GetParentGroupId()

KIID EDA_ITEM::GetParentGroupId ( ) const
inherited

Definition at line 91 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

Referenced by ITEM_PICKER::SetItem(), and ITEM_PICKER::SetLink().

◆ GetParentSymbol() [1/2]

SYMBOL * SCH_ITEM::GetParentSymbol ( )
inherited

Definition at line 235 of file sch_item.cpp.

References EDA_ITEM::findParent(), LIB_SYMBOL, LIB_SYMBOL_T, and SCH_SYMBOL_T.

◆ GetParentSymbol() [2/2]

◆ GetPenWidth()

virtual int SCH_ITEM::GetPenWidth ( ) const
inlinevirtualinherited
Returns
the size of the "pen" that be used to draw or plot this item

Reimplemented in SCH_BUS_BUS_ENTRY, SCH_BUS_ENTRY_BASE, SCH_BUS_WIRE_ENTRY, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHAPE, SCH_SHEET, SCH_SHEET_PIN, and SCH_TEXT.

Definition at line 320 of file sch_item.h.

Referenced by EE_RTREE::contains(), GetEffectivePenWidth(), EE_RTREE::insert(), and EE_RTREE::remove().

◆ GetPosition()

VECTOR2I SCH_BITMAP::GetPosition ( ) const
overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 103 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by KIGFX::SCH_PAINTER::draw(), GetX(), GetY(), Move(), Plot(), and SCH_IO_KICAD_LEGACY::saveBitmap().

◆ GetReferenceImage() [1/2]

REFERENCE_IMAGE & SCH_BITMAP::GetReferenceImage ( )
inline
Returns
the underlying reference image object.

Definition at line 51 of file sch_bitmap.h.

References m_referenceImage.

Referenced by DIALOG_IMAGE_PROPERTIES::DIALOG_IMAGE_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_IO_KICAD_LEGACY::saveBitmap(), and SCH_IO_KICAD_SEXPR::saveBitmap().

◆ GetReferenceImage() [2/2]

const REFERENCE_IMAGE & SCH_BITMAP::GetReferenceImage ( ) const
inline

Definition at line 52 of file sch_bitmap.h.

References m_referenceImage.

◆ getRenderSettings()

◆ GetRuleAreaCache()

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

Get the cache of rule areas enclosing this item.

Definition at line 645 of file sch_item.h.

References m_rule_areas_cache.

Referenced by CONNECTION_SUBGRAPH::GetNetclassesForDriver().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const
inlinevirtualinherited

Return the coordinates that should be used for sorting this element visually compared to other elements.

For instance, for lines the midpoint might be a better sorting point than either end.

Returns
X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 288 of file eda_item.h.

References GetPosition().

◆ GetStoredPos()

VECTOR2I & SCH_ITEM::GetStoredPos ( )
inlineinherited

Definition at line 279 of file sch_item.h.

References m_storedPos.

◆ GetStroke()

virtual STROKE_PARAMS SCH_ITEM::GetStroke ( ) const
inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 610 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const
inlineinherited

◆ GetTransformOriginOffsetX()

int SCH_BITMAP::GetTransformOriginOffsetX ( ) const
private

Definition at line 234 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ GetTransformOriginOffsetY()

int SCH_BITMAP::GetTransformOriginOffsetY ( ) const
private

Definition at line 248 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const
inherited

Return a translated description of the type for this EDA_ITEM for display in user facing messages.

Definition at line 392 of file eda_item.cpp.

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

Referenced by EDIT_TOOL::doMoveSelection(), and GetFriendlyName().

◆ GetUnit()

int SCH_ITEM::GetUnit ( ) const
inlineinherited

Definition at line 238 of file sch_item.h.

References m_unit.

Referenced by SCH_IO_EAGLE::addImplicitConnections(), SCH_SHEET_PATH::AddNewSymbolInstances(), SCH_EDIT_FRAME::AnnotateSymbols(), BOOST_AUTO_TEST_CASE(), SCH_SHEET_PATH::CheckForMissingSymbolInstances(), SCH_PIN::Clone(), SCH_EDIT_TOOL::collectUnits(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SCH_EDIT_FRAME::DeleteAnnotation(), SCH_INSPECTION_TOOL::DiffSymbol(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_SYMBOL::doIsConnected(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_EDITOR_CONTROL::EditWithSymbolEditor(), RESCUE_CACHE_CANDIDATE::FindRescues(), RESCUE_SYMBOL_LIB_TABLE_CANDIDATE::FindRescues(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), PIN_INFO_FORMATTER::Format(), SCH_SYMBOL::GetConnectionPoints(), SCH_SYMBOL::GetEndPoints(), GetMsgPanelInfo(), SCH_SYMBOL::GetPin(), SCH_COLLECTOR::Inspect(), SCH_SYMBOL::IsPointClickableAnchor(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), SCH_SYMBOL::operator==(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_SYMBOL::Plot(), SCH_SYMBOL::PlotPins(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_EDIT_TOOL::Properties(), CONNECTION_GRAPH::Recalculate(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveBezier(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveCircle(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePin(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveRectangle(), SCH_IO_KICAD_LEGACY::saveSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SCH_ITEM_DESC::SCH_ITEM_DESC(), SCHEMATIC::SCHEMATIC(), SCH_SELECTION_TOOL::Selectable(), SCH_EDIT_FRAME::SelectUnit(), PIN_TABLE_DATA_MODEL::SetValue(), sort_by_pin_number(), DIALOG_FIELD_PROPERTIES::TransferDataToWindow(), SYMBOL_UNIT_MENU::update(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and SCH_SYMBOL::Visit().

◆ GetUnitDisplayName()

wxString SCH_ITEM::GetUnitDisplayName ( int aUnit,
bool aLabel ) const
virtualinherited

Reimplemented in LIB_SYMBOL, and SCH_SYMBOL.

Definition at line 168 of file sch_item.cpp.

References _, _HKI, and GetParentSymbol().

Referenced by PIN_INFO_FORMATTER::Format(), and GetMsgPanelInfo().

◆ GetWidth()

int SCH_BITMAP::GetWidth ( ) const
private

Definition at line 274 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ GetX()

int SCH_BITMAP::GetX ( ) const
inline

Definition at line 54 of file sch_bitmap.h.

References GetPosition(), and VECTOR2< T >::x.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC(), and SetY().

◆ GetY()

int SCH_BITMAP::GetY ( ) const
inline

Definition at line 57 of file sch_bitmap.h.

References GetPosition(), and VECTOR2< T >::y.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC(), and SetX().

◆ HasCachedDriverName()

virtual bool SCH_ITEM::HasCachedDriverName ( ) const
inlinevirtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 582 of file sch_item.h.

Referenced by CONNECTION_SUBGRAPH::GetNameForDriver().

◆ HasConnectivityChanges()

virtual bool SCH_ITEM::HasConnectivityChanges ( const SCH_ITEM * aItem,
const SCH_SHEET_PATH * aInstance = nullptr ) const
inlinevirtualinherited

Check if aItem has connectivity changes against this object.

This provides granular per object connectivity change testing to prevent the need to rebuild the CONNECTION_GRAPH when object properties that have nothing to do with the schematic connectivity changes i.e. color, thickness, fill type. etc.

Note
Developers should override this method for all objects that are connectable.
Parameters
aItemis the item to test for connectivity changes.
aInstanceis the instance to test for connectivity changes. This parameter is only meaningful for SCH_SYMBOL objects.
Returns
true if there are connectivity changes otherwise false.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 573 of file sch_item.h.

References SCH_ITEM().

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

◆ HasFlag()

◆ HasLineStroke()

virtual bool SCH_ITEM::HasLineStroke ( ) const
inlinevirtualinherited

Check if this schematic item has line stoke properties.

See also
STROKE_PARAMS
Returns
true if this schematic item support line stroke properties. Otherwise, false.

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 608 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ HitTest() [1/3]

bool SCH_BITMAP::HitTest ( const BOX2I & aRect,
bool aContained,
int aAccuracy = 0 ) const
overridevirtual

Test if aRect intersects this item.

Parameters
aRectA reference to a BOX2I object containing the rectangle to test.
aContainedSet to true to test for containment instead of an intersection.
aAccuracyIncrease aRect by this amount.
Returns
True if aRect contains or intersects the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 156 of file sch_bitmap.cpp.

References KIGEOM::BoxHitTest(), and GetBoundingBox().

◆ HitTest() [2/3]

bool SCH_BITMAP::HitTest ( const SHAPE_LINE_CHAIN & aPoly,
bool aContained ) const
overridevirtual

Test if aPoly intersects this item.

Parameters
aPolyA reference to a SHAPE_LINE_CHAIN object containing the polygon or polyline to test.
aContainedSet to true to test for containment instead of an intersection.
Returns
True if aPoly contains or intersects the item.

Reimplemented from EDA_ITEM.

Definition at line 162 of file sch_bitmap.cpp.

References KIGEOM::BoxHitTest(), and GetBoundingBox().

◆ HitTest() [3/3]

bool SCH_BITMAP::HitTest ( const VECTOR2I & aPosition,
int aAccuracy = 0 ) const
overridevirtual

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

Parameters
aPositionA reference to a VECTOR2I object containing the coordinates to test.
aAccuracyIncrease the item bounding box by this amount.
Returns
True if aPosition is within the item bounding box.

Reimplemented from EDA_ITEM.

Definition at line 150 of file sch_bitmap.cpp.

References KIGEOM::BoxHitTest(), and GetBoundingBox().

◆ InitializeConnection()

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

Create a new connection object associated with this object.

Parameters
aPathis the sheet path to initialize.

Definition at line 404 of file sch_item.cpp.

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

Referenced by GetOrInitConnection(), and CONNECTION_GRAPH::updateGenericItemConnectivity().

◆ IsBOARD_ITEM()

◆ IsBrightened()

◆ IsConnectable()

◆ IsConnected()

bool SCH_ITEM::IsConnected ( const VECTOR2I & aPoint) const
inherited

Test the item to see if it is connected to aPoint.

Parameters
aPointis a reference to a VECTOR2I object containing the coordinates to test.
Returns
True if connection to aPoint exists.

Definition at line 314 of file sch_item.cpp.

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

Referenced by JUNCTION_HELPERS::AnalyzePoint(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_MOVE_TOOL::getConnectedItems(), SCH_SCREEN::IsTerminalPoint(), and SCH_SCREEN::MarkConnections().

◆ IsConnectivityDirty()

◆ IsDangling()

virtual bool SCH_ITEM::IsDangling ( ) const
inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_DIRECTIVE_LABEL, SCH_LABEL_BASE, SCH_LINE, and SCH_PIN.

Definition at line 486 of file sch_item.h.

◆ IsEndPoint()

virtual bool SCH_ITEM::IsEndPoint ( const VECTOR2I & aPt) const
inlinevirtualinherited

Test if aPt is an end point of this schematic object.

Note
The end point test doe not imply electrical connectivity. See IsConnectable(). In other words all connection points are end points but not all end points are connection points such as graphical lines and arcs. Override this method for all objects that have end points.
Parameters
aPtis the coordinate to test for an end point.
Return values
trueif aPt is an end point.
falseif aPt is not an end point.

Reimplemented in SCH_LINE, and SCH_SHAPE.

Definition at line 484 of file sch_item.h.

Referenced by SCH_SCREEN::MarkConnections().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 128 of file eda_item.h.

References ENTERED, and m_flags.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), and KIGFX::SCH_PAINTER::draw().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

◆ IsGroupableType()

◆ IsHypertext()

virtual bool SCH_ITEM::IsHypertext ( ) const
inlinevirtualinherited

Allow items to support hypertext actions when hovered/clicked.

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 302 of file sch_item.h.

Referenced by RenderAsBitmap().

◆ IsLocked()

virtual bool EDA_ITEM::IsLocked ( ) const
inlinevirtualinherited

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 123 of file eda_item.h.

References IS_CHANGED, and m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMovableFromAnchorPoint()

bool SCH_BITMAP::IsMovableFromAnchorPoint ( ) const
inlineoverridevirtual

Return true for items which are moved with the anchor point at mouse cursor and false for items moved with no reference to anchor.

Returns
false for a bus entry.

Reimplemented from SCH_ITEM.

Definition at line 83 of file sch_bitmap.h.

◆ IsMoving()

◆ IsNew()

◆ IsPointClickableAnchor()

virtual bool SCH_ITEM::IsPointClickableAnchor ( const VECTOR2I & aPos) const
inlinevirtualinherited
Returns
true if the given point can start drawing (usually means the anchor is unused/free/dangling).

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_JUNCTION, SCH_LABEL, SCH_LINE, SCH_PIN, SCH_SHEET_PIN, and SCH_SYMBOL.

Definition at line 499 of file sch_item.h.

Referenced by SCH_SELECTION_TOOL::autostartEvent().

◆ IsPrivate()

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const
inlinevirtualinherited

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

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

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

Definition at line 439 of file eda_item.h.

Referenced by Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const
inlineinherited

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const
inlineinherited

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const
inlineinherited

Definition at line 127 of file eda_item.h.

References m_flags, and SELECTED.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::drawItemBoundingBox(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), 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(), DIALOG_CHANGE_SYMBOLS::isMatch(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), KIGFX::SCH_PAINTER::nonCached(), SCH_MOVE_TOOL::orthoLineDrag(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_SELECTION_TOOL::RebuildSelection(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), SCH_IO_KICAD_SEXPR::saveTable(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_TEST_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), SCH_EDIT_FRAME::SelectBodyStyle(), PCB_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::SelectColumns(), PCB_SELECTION_TOOL::SelectMultiple(), SCH_SELECTION_TOOL::SelectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::SelectRows(), SCH_SELECTION_TOOL::SelectRows(), SCH_COMMIT::Stage(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_FIND_REPLACE_TOOL::UpdateFind(), SCH_SYMBOL::UpdatePins(), PCB_TUNING_PATTERN::ViewDraw(), PCB_FIELD::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const
inlineinherited

Definition at line 184 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsType()

◆ IterateForward() [1/2]

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

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

Definition at line 325 of file eda_item.h.

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

Referenced by BOARD::Visit(), FOOTPRINT::Visit(), and GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

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

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

Definition at line 345 of file eda_item.h.

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

◆ lodScaleForThreshold()

double VIEW_ITEM::lodScaleForThreshold ( const KIGFX::VIEW * aView,
int aWhatIu,
int aThresholdIu )
staticprotectedinherited

Get the scale at which aWhatIu would be drawn at the same size as aThresholdIu on screen.

This is useful when a level-of-detail is defined in terms of a threshold size (i.e. 'only draw X when it will be bigger than Y size on screen').

E.g. if aWhatIu is 1000 and aThresholdIu is 100, then the item will be the same size as the threshold at 0.1 scale. Returning that 0.1 as the LoD will hide the item when the scale is less than 0.1 - i.e. smaller than the threshold.

Because even at zoom 1.0, 1mm in KiCad may not be exactly 1mm on a physical screen, the threshold may not be exact in practice.

Definition at line 39 of file view_item.cpp.

References KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), KIGFX::RENDER_SETTINGS::IsPrinting(), LOD_HIDE, LOD_SHOW, and VIEW.

Referenced by GERBER_DRAW_ITEM::ViewGetLOD(), PAD::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), and SCH_LINE::ViewGetLOD().

◆ Matches() [1/2]

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

Compare the item against the search criteria in aSearchData.

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search criteria.
aAuxDataA 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 FOOTPRINT, NETINFO_ITEM, PCB_FIELD, PCB_GROUP, PCB_MARKER, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, SCH_FIELD, SCH_GROUP, SCH_LABEL_BASE, SCH_MARKER, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, and ZONE.

Definition at line 401 of file eda_item.h.

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

◆ Matches() [2/2]

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

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters
aTextA reference to a wxString object containing the string to test.
aSearchDataThe criteria to search against.
Returns
True if aText matches the search criteria in aSearchData.

Definition at line 158 of file eda_item.cpp.

References CTX_SEARCH, EDA_COMBINED_MATCHER::Find(), EDA_SEARCH_DATA::findString, flag, IsReplaceable(), isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), PERMISSIVE, REGEX, EDA_SEARCH_DATA::regex, EDA_SEARCH_DATA::regex_string, EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ MirrorHorizontally()

void SCH_BITMAP::MirrorHorizontally ( int aCenter)
overridevirtual

Mirror item horizontally about aCenter.

Reimplemented from SCH_ITEM.

Definition at line 127 of file sch_bitmap.cpp.

References LEFT_RIGHT, and m_referenceImage.

◆ MirrorVertically()

void SCH_BITMAP::MirrorVertically ( int aCenter)
overridevirtual

Mirror item vertically about aCenter.

Reimplemented from SCH_ITEM.

Definition at line 121 of file sch_bitmap.cpp.

References m_referenceImage, and TOP_BOTTOM.

◆ Move()

void SCH_BITMAP::Move ( const VECTOR2I & aMoveVector)
overridevirtual

Move the item by aMoveVector to a new position.

Reimplemented from SCH_ITEM.

Definition at line 115 of file sch_bitmap.cpp.

References GetPosition(), and SetPosition().

◆ operator<() [1/2]

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

Test if another item is less than this object.

Parameters
aItem- Item to compare against.
Returns
- True if aItem is less than the item.

Definition at line 319 of file eda_item.cpp.

References EDA_ITEM(), and KIGFX::VIEW_ITEM::GetClass().

◆ operator<() [2/2]

bool SCH_ITEM::operator< ( const SCH_ITEM & aItem) const
virtualinherited

◆ operator=()

SCH_BITMAP & SCH_BITMAP::operator= ( const SCH_ITEM & aItem)

◆ operator==()

bool SCH_BITMAP::operator== ( const SCH_ITEM & aOther) const
overridevirtual

Reimplemented from SCH_ITEM.

Definition at line 211 of file sch_bitmap.cpp.

References m_referenceImage, SCH_BITMAP(), SCH_ITEM::SCH_ITEM(), and EDA_ITEM::Type().

◆ Plot()

void SCH_BITMAP::Plot ( PLOTTER * aPlotter,
bool aBackground,
const SCH_PLOT_OPTS & aPlotOpts,
int aUnit,
int aBodyStyle,
const VECTOR2I & aOffset,
bool aDimmed )
overridevirtual

Plot the item to aPlotter.

Parameters
aBackgrounda poor-man's Z-order. The routine will get called twice, first with aBackground true and then with aBackground false.
aUnit- which unit to print.
aBodyStyle- which body style to print.
aOffsetrelative offset.
aDimmedreduce brightness of item.

Reimplemented from SCH_ITEM.

Definition at line 169 of file sch_bitmap.cpp.

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), SCH_ITEM::GetLayer(), KIGFX::RENDER_SETTINGS::GetLayerColor(), GetPosition(), m_referenceImage, and PLOTTER::RenderSettings().

◆ RenderAsBitmap()

bool SCH_ITEM::RenderAsBitmap ( double aWorldScale) const
overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 625 of file sch_item.cpp.

References BITMAP_FONT_SIZE_THRESHOLD, IsHypertext(), and text.

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

◆ Replace() [1/2]

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

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

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aAuxDataA 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_FIELD, SCH_LABEL_BASE, SCH_PIN, SCH_SHEET_PIN, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 428 of file eda_item.h.

◆ Replace() [2/2]

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

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

Parameters
aSearchDataA reference to a wxFindReplaceData object containing the search and replace criteria.
aTextA reference to a wxString object containing the text to be replaced.
Returns
True if aText was modified, otherwise false.

Definition at line 236 of file eda_item.cpp.

References EDA_SEARCH_DATA::findString, flag, isWordChar(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), REGEX, EDA_SEARCH_DATA::regex, EDA_SEARCH_DATA::regex_string, EDA_SEARCH_DATA::replaceString, result, text, and WHOLEWORD.

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

◆ ResolveDNP()

bool SCH_ITEM::ResolveDNP ( ) const
inherited

◆ ResolveExcludedFromBoard()

bool SCH_ITEM::ResolveExcludedFromBoard ( ) const
inherited

◆ ResolveExcludedFromBOM()

bool SCH_ITEM::ResolveExcludedFromBOM ( ) const
inherited

◆ ResolveExcludedFromSim()

◆ Rotate()

void SCH_BITMAP::Rotate ( const VECTOR2I & aCenter,
bool aRotateCCW )
overridevirtual

Rotate the item around aCenter 90 degrees in the clockwise direction.

Reimplemented from SCH_ITEM.

Definition at line 133 of file sch_bitmap.cpp.

References ANGLE_270, ANGLE_90, and m_referenceImage.

◆ RunOnChildren()

◆ Schematic()

SCHEMATIC * SCH_ITEM::Schematic ( ) const
inherited

Search the item hierarchy to find a SCHEMATIC.

Every SCH_ITEM that lives on a SCH_SCREEN should be parented to either that screen or another SCH_ITEM on the same screen (for example, pins to their symbols).

Every SCH_SCREEN should be parented to the SCHEMATIC.

Note
This hierarchy is not the same as the sheet hierarchy!
Returns
the parent schematic this item lives on, or nullptr.

Definition at line 217 of file sch_item.cpp.

References EDA_ITEM::findParent(), and SCHEMATIC_T.

Referenced by FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), SCH_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::ChangeTextType(), Connection(), SCH_DRAWING_TOOLS::createNewSheetPin(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_SIM_MODEL< T >::DIALOG_SIM_MODEL(), SCH_FIELD::DoHypertextAction(), KIGFX::SCH_PAINTER::draw(), FIELDS_GRID_TABLE::FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE::FIELDS_GRID_TABLE(), FIELDS_GRID_TABLE::FIELDS_GRID_TABLE(), SCH_SHEET::findSelf(), SCH_MARKER::GetColorLayer(), SCH_SHEET::GetContextualTextVars(), GetEffectiveNetClass(), SCH_JUNCTION::getEffectiveShape(), SCH_SHAPE::GetEffectiveWidth(), GetEmbeddedFonts(), GetFontMetrics(), SCH_LABEL_BASE::GetIntersheetRefs(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_SHAPE::getMaxError(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_NO_CONNECT::GetPenWidth(), SCH_SHEET::GetPenWidth(), SCH_SHEET_PIN::GetPenWidth(), SCH_SYMBOL::GetPins(), SCH_SYMBOL::GetRefProp(), SCH_MARKER::GetSeverity(), SCH_FIELD::GetShownText(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_TEXT::GetTextOffset(), SCH_SYMBOL::GetUnitProp(), GetUnplacedUnitsForSymbol(), SCH_SYMBOL::GetValueProp(), SCH_PIN::HitTest(), SCH_SHEET::IsRootSheet(), SCH_LABEL_BASE::IsType(), SCH_POINT_EDITOR::makePointsAndBehavior(), SIM_MODEL::MigrateSimModel(), SCH_FIELD::OnScintillaCharAdded(), PIN_LAYOUT_CACHE::PIN_LAYOUT_CACHE(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_SCREEN::Plot(), SCH_SYMBOL::Plot(), SCH_TABLE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_COMMIT::pushSchEdit(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SHEET::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), SCH_COMMIT::Revert(), SCH_FIELD::SCH_FIELD(), SCH_EDIT_FRAME::SelectUnit(), SCH_MARKER::SerializeToString(), SCH_SYMBOL::SetRef(), SCH_SYMBOL::SetRefProp(), SCH_SYMBOL::SetUnitProp(), SCH_INSPECTION_TOOL::ShowDatasheet(), SCH_EDITOR_CONTROL::SimTune(), SCH_SYMBOL::SubReference(), SCH_SYMBOL::SyncOtherUnits(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_MARKER::ViewGetLayers(), and ~SCH_ITEM().

◆ Serialize()

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

Serializes this object to the given Any message.

The Any message's concrete type will be specific to the object in question.

Parameters
aContainerwill be filled with a message describing this object

Reimplemented in BOARD_STACKUP, EDA_SHAPE, EDA_TEXT, FOOTPRINT, NETCLASS, PAD, PADSTACK, PCB_ARC, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GROUP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, and ZONE.

Definition at line 24 of file serializable.cpp.

Referenced by API_HANDLER_PCB::handleCreateUpdateItemsInternal(), and ~SERIALIZABLE().

◆ Set() [1/4]

template<typename T>
bool INSPECTABLE::Set ( const wxString & aProperty,
T aValue,
bool aNotify = true )
inlineinherited

◆ Set() [2/4]

template<typename T>
bool INSPECTABLE::Set ( PROPERTY_BASE * aProperty,
T aValue,
bool aNotify = true )
inlineinherited

◆ Set() [3/4]

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

◆ Set() [4/4]

bool INSPECTABLE::Set ( PROPERTY_BASE * aProperty,
wxVariant aValue,
bool aNotify = true )
inlineinherited

◆ SetBodyStyle()

◆ SetBodyStyleProp()

void SCH_ITEM::SetBodyStyleProp ( const wxString & aBodyStyle)
virtualinherited

Reimplemented in SCH_SYMBOL.

Definition at line 189 of file sch_item.cpp.

References _HKI, BASE, DEMORGAN, GetParentSymbol(), and m_bodyStyle.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ SetBrightened()

◆ SetConnectionGraph()

void SCH_ITEM::SetConnectionGraph ( CONNECTION_GRAPH * aGraph)
inherited

Update the connection graph for all connections in this item.

Definition at line 340 of file sch_item.cpp.

References CONNECTION_GRAPH, m_connection_map, and path.

Referenced by CONNECTION_GRAPH::Merge().

◆ SetConnectivityDirty()

◆ SetDNP()

virtual void SCH_ITEM::SetDNP ( bool aDNP)
inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 264 of file sch_item.h.

◆ SetExcludedFromBoard()

virtual void SCH_ITEM::SetExcludedFromBoard ( bool aExcludeFromBoard)
inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 260 of file sch_item.h.

◆ SetExcludedFromBOM()

virtual void SCH_ITEM::SetExcludedFromBOM ( bool aExcludeFromBOM)
inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, and SYMBOL.

Definition at line 256 of file sch_item.h.

◆ SetExcludedFromSim()

virtual void SCH_ITEM::SetExcludedFromSim ( bool aExclude)
inlinevirtualinherited

Reimplemented in SCH_RULE_AREA, SCH_SHEET, SCH_TEXT, SCH_TEXTBOX, and SYMBOL.

Definition at line 252 of file sch_item.h.

◆ SetFieldsAutoplaced()

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask)
inlineinherited

Definition at line 142 of file eda_item.h.

References m_flags.

Referenced by SCH_IO_EAGLE::addBusEntries(), PCB_BASE_FRAME::AddFootprintToBoard(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), SCH_IO_ALTIUM::AddTextBox(), SCH_MOVE_TOOL::AlignToGrid(), PCB_CONTROL::ApplyDesignBlockLayout(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), BOARD_BOUNDING_BOX::BOARD_BOUNDING_BOX(), BOARD_BOUNDING_BOX::BOARD_BOUNDING_BOX(), BOOST_AUTO_TEST_CASE(), SCH_LINE_WIRE_BUS_TOOL::BreakSegment(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), SCH_EDIT_TOOL::ChangeTextType(), GRAPHICS_CLEANER::cleanupShapes(), ConnectBoardShapes(), SCH_IO_ALTIUM::CreateAliases(), PCB_TUNING_PATTERN::CreateNew(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), SCH_EDIT_FRAME::DeleteJunction(), doConvertOutlineToPolygon(), SCH_EDIT_TOOL::DoDelete(), SCH_LINE_WIRE_BUS_TOOL::doDrawSegments(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawArc(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), SCH_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawSheet(), PCB_TUNING_PATTERN::EditStart(), SCH_SELECTION_TOOL::EnterGroup(), PAD_TOOL::explodePad(), SCH_MOVE_TOOL::getConnectedDragItems(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_DRAWING_TOOLS::ImportSheet(), SCH_COLLECTOR::Inspect(), BOARD_COMMIT::MakeImage(), CONVERT_TOOL::makePolysFromChainedSegs(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), SCH_SCREEN::MarkConnections(), TRACKS_CLEANER::mergeCollinearSegments(), SCH_MOVE_TOOL::moveItem(), SYMBOL_EDITOR_MOVE_TOOL::moveItem(), KIGFX::ORIGIN_VIEWITEM::ORIGIN_VIEWITEM(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseBus(), SCH_IO_ALTIUM::ParseBusEntry(), SCH_IO_ALTIUM::ParseHarnessEntry(), SCH_IO_ALTIUM::ParseJunction(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLine(), SCH_IO_ALTIUM::ParseNetLabel(), SCH_IO_ALTIUM::ParseNoERC(), SCH_IO_ALTIUM::ParsePieChart(), SCH_IO_ALTIUM::ParsePolygon(), SCH_IO_ALTIUM::ParsePolyline(), SCH_IO_ALTIUM::ParsePortHelper(), SCH_IO_ALTIUM::ParseRectangle(), SCH_IO_ALTIUM::ParseRoundRectangle(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_IO_ALTIUM::ParseSheetSymbol(), SCH_IO_ALTIUM::ParseSignalHarness(), SCH_IO_ALTIUM::ParseWire(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_BOARD_OUTLINE::PCB_BOARD_OUTLINE(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PL_DRAWING_TOOLS::PlaceItem(), SCH_SYMBOL::Plot(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SYMBOL_EDIT_FRAME::PushSymbolToUndoList(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), GERBVIEW_FRAME::RemapLayers(), BOARD::Remove(), FOOTPRINT::Remove(), PCB_TUNING_PATTERN::Remove(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_EDIT_TOOL::Rotate(), SCH_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), SCH_IO_KICAD_SEXPR::saveTable(), PCB_SELECTION_TOOL::selectAllConnectedShapes(), SCH_SELECTION_TOOL::SelectMultiple(), SetBrightened(), SetIsShownAsBitmap(), SetModified(), SetSelected(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_ITEM::SwapFlags(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

◆ SetForcedTransparency()

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

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

References m_forceVisible.

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

◆ SetHeight()

void SCH_BITMAP::SetHeight ( int aHeight)
private

Definition at line 292 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ SetImageScale()

void SCH_BITMAP::SetImageScale ( double aScale)
private

Definition at line 268 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ SetIsRollover()

void EDA_ITEM::SetIsRollover ( bool aIsRollover)
inlineinherited

Definition at line 132 of file eda_item.h.

References m_isRollover.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap)
inlineinherited

Definition at line 176 of file eda_item.h.

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

◆ SetLastResolvedState()

virtual void SCH_ITEM::SetLastResolvedState ( const SCH_ITEM * aItem)
inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, and SCH_LINE.

Definition at line 585 of file sch_item.h.

References SCH_ITEM().

Referenced by SCH_EDITOR_CONTROL::Paste().

◆ SetLayer()

◆ SetLocked()

virtual void EDA_ITEM::SetLocked ( bool aLocked)
inlinevirtualinherited

Reimplemented in BOARD_ITEM, FOOTPRINT, and PCB_GROUP.

Definition at line 121 of file eda_item.h.

Referenced by SCH_ITEM_DESC::SCH_ITEM_DESC().

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent)
inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and NETINFO_ITEM.

Definition at line 113 of file eda_item.h.

References EDA_ITEM(), and m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), PCB_TABLE::AddCell(), SCH_TABLE::AddCell(), LIB_SYMBOL::AddDrawItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PADSTACK::AddPrimitive(), PAD::AddPrimitivePoly(), PAD::AddPrimitivePoly(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), CADSTAR_SCH_ARCHIVE_LOADER::copySymbolItems(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol(), FIELDS_GRID_TABLE::DetachFields(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_DRAWING_TOOLS::DrawShape(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_IO_KICAD_SEXPR::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), PCB_TABLE::InsertCell(), SCH_TABLE::InsertCell(), LIB_SYMBOL::LIB_SYMBOL(), LTSPICE_SCHEMATIC::Load(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), KI_TEST::LoadHierarchy(), SCH_IO_KICAD_LEGACY::loadHierarchy(), SCH_IO_KICAD_SEXPR::loadHierarchy(), SCH_IO_EAGLE::loadSymbolPolyLine(), SCH_IO_EAGLE::loadSymbolRectangle(), SCH_IO_EAGLE::loadSymbolWire(), PCB_POINT_EDITOR::OnSelectionChange(), LIB_SYMBOL::operator=(), SCH_IO_KICAD_SEXPR_PARSER::parseLibSymbol(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), PAD::Recombine(), SCH_IO_LIB_CACHE::removeSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CLIPBOARD_IO::SaveSelection(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), FOOTPRINT::swapData(), PCB_TABLE::swapData(), SCH_LABEL_BASE::swapData(), SCH_SHEET::swapData(), SCH_SYMBOL::swapData(), SCH_TABLE::swapData(), BOARD_ITEM::SwapItemData(), SCH_ITEM::SwapItemData(), SCH_SYMBOL::SyncOtherUnits(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetParentGroup()

◆ SetPosition()

void SCH_BITMAP::SetPosition ( const VECTOR2I & aPosition)
overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 109 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by Move(), SetX(), and SetY().

◆ SetPrivate()

◆ SetSelected()

◆ SetStoredPos()

void SCH_ITEM::SetStoredPos ( const VECTOR2I & aPos)
inlineinherited

Definition at line 280 of file sch_item.h.

References m_storedPos.

Referenced by SCH_MOVE_TOOL::doMoveSelection().

◆ SetStroke()

virtual void SCH_ITEM::SetStroke ( const STROKE_PARAMS & aStroke)
inlinevirtualinherited

Reimplemented in SCH_BUS_ENTRY_BASE, SCH_LINE, and SCH_SHAPE.

Definition at line 612 of file sch_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ SetTransformOriginOffsetX()

void SCH_BITMAP::SetTransformOriginOffsetX ( int aX)
private

Definition at line 240 of file sch_bitmap.cpp.

References m_referenceImage, and VECTOR2< T >::x.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ SetTransformOriginOffsetY()

void SCH_BITMAP::SetTransformOriginOffsetY ( int aY)
private

Definition at line 254 of file sch_bitmap.cpp.

References m_referenceImage, and VECTOR2< T >::y.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ SetUnit()

virtual void SCH_ITEM::SetUnit ( int aUnit)
inlinevirtualinherited

Definition at line 237 of file sch_item.h.

References m_unit.

Referenced by SCH_IO_ALTIUM::AddLibTextBox(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CADSTAR_SCH_ARCHIVE_LOADER::copySymbolItems(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SYMBOL_EDITOR_EDIT_TOOL::ExplodeStackedPin(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadPolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadRect(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolGateAndPartFields(), SCH_IO_EAGLE::loadSymbolPolyLine(), SCH_IO_EAGLE::loadSymbolRectangle(), SCH_IO_EAGLE::loadSymbolWire(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), SCH_IO_ALTIUM::ParseArc(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseComponent(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_ALTIUM::ParseEllipticalArc(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLine(), SCH_IO_ALTIUM::ParsePieChart(), SCH_IO_ALTIUM::ParsePolygon(), SCH_IO_ALTIUM::ParsePolyline(), SCH_IO_ALTIUM::ParseRectangle(), SCH_IO_ALTIUM::ParseRoundRectangle(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_DRAWING_TOOLS::PlaceSymbol(), CONNECTION_GRAPH::Recalculate(), SCH_ITEM_DESC::SCH_ITEM_DESC(), SCH_EDIT_FRAME::SelectUnit(), SCH_SYMBOL::SetUnitProp(), PIN_TABLE_DATA_MODEL::SetValue(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_EDITOR_CONTROL::updatePastedSymbol(), and PIN_INFO_FORMATTER::UpdatePin().

◆ SetWidth()

void SCH_BITMAP::SetWidth ( int aWidth)
private

Definition at line 280 of file sch_bitmap.cpp.

References m_referenceImage.

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ SetX()

void SCH_BITMAP::SetX ( int aX)
inline

Definition at line 55 of file sch_bitmap.h.

References GetY(), and SetPosition().

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ SetY()

void SCH_BITMAP::SetY ( int aY)
inline

Definition at line 58 of file sch_bitmap.h.

References GetX(), and SetPosition().

Referenced by SCH_BITMAP_DESC::SCH_BITMAP_DESC().

◆ Similarity()

double SCH_BITMAP::Similarity ( const SCH_ITEM & aItem) const
overridevirtual

Return a measure of how likely the other object is to represent the same object.

The scale runs from 0.0 (definitely different objects) to 1.0 (same)

Reimplemented from SCH_ITEM.

Definition at line 221 of file sch_bitmap.cpp.

References m_referenceImage, EDA_ITEM::m_Uuid, SCH_BITMAP(), SCH_ITEM::SCH_ITEM(), and EDA_ITEM::Type().

◆ SimilarityBase()

double SCH_ITEM::SimilarityBase ( const SCH_ITEM & aItem) const
inlineinherited

Calculate the boilerplate similarity for all LIB_ITEMs without preventing the use above of a pure virtual function that catches at compile time when a new object has not been fully implemented.

Definition at line 346 of file sch_item.h.

References m_bodyStyle, m_private, m_unit, and SCH_ITEM().

Referenced by SCH_FIELD::Similarity(), SCH_PIN::Similarity(), SCH_SHAPE::Similarity(), SCH_TEXT::Similarity(), and SCH_TEXTBOX::Similarity().

◆ Sort()

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

Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Parameters
aLeftThe left hand item to compare.
aRightThe right hand item to compare.
Returns
True if aLeft is less than aRight.

Definition at line 457 of file eda_item.h.

References EDA_ITEM().

◆ swapData()

void SCH_BITMAP::swapData ( SCH_ITEM * aItem)
overrideprotectedvirtual

Swap the internal data structures aItem with the schematic item.

Obviously, aItem must have the same type than me.

Parameters
aItemThe item to swap the data structures with.

Reimplemented from SCH_ITEM.

Definition at line 86 of file sch_bitmap.cpp.

References SCH_ITEM::GetClass(), m_referenceImage, SCH_BITMAP(), SCH_BITMAP_T, SCH_ITEM::SCH_ITEM(), and EDA_ITEM::Type().

◆ SwapFlags()

void SCH_ITEM::SwapFlags ( SCH_ITEM * aItem)
inherited

◆ SwapItemData()

void SCH_ITEM::SwapItemData ( SCH_ITEM * aImage)
inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

Used in undo and redo commands to swap values between an item and its copy. Only values like layer, size .. which are modified by editing are swapped.

Parameters
aImagethe item image which contains data to swap.

Definition at line 456 of file sch_item.cpp.

References EDA_ITEM::EDA_ITEM(), EDA_ITEM::GetParent(), m_bodyStyle, m_fieldsAutoplaced, EDA_ITEM::m_group, m_layer, m_private, m_unit, SCH_ITEM(), EDA_ITEM::SetParent(), swapData(), and SwapFlags().

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

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

References m_structType.

Referenced by BOARD::Add(), CN_CLUSTER::Add(), CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::Add(), KIGFX::PCB_VIEW::Add(), PCB_GRID_HELPER::AddConstructionItems(), PCB_POINT_EDITOR::addCorner(), CONNECTION_SUBGRAPH::AddItem(), DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), ZONE_FILLER::addKnockout(), ZONE_FILLER::addKnockout(), SCH_SHEET::AddPin(), SCH_BASE_FRAME::AddToScreen(), SCH_MOVE_TOOL::AlignToGrid(), SCH_SCREEN::Append(), PCB_CONTROL::ApplyDesignBlockLayout(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), TEARDROP_MANAGER::areItemsInSameZone(), PNS::TOPOLOGY::AssembleTuningPath(), SCH_LABEL_BASE::AutoplaceFields(), SCH_EDIT_FRAME::AutoRotateItem(), SCH_SELECTION_TOOL::autostartEvent(), SCH_EDIT_TOOL::BreakWire(), EXPORTER_STEP::buildGraphic3DShape(), SCH_SCREENS::buildScreenList(), EXPORTER_STEP::buildTrack3DShape(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), canAddCorner(), canChamferCorner(), SCH_BUS_BUS_ENTRY::CanConnect(), SCH_BUS_WIRE_ENTRY::CanConnect(), SCH_JUNCTION::CanConnect(), SCH_LABEL_BASE::CanConnect(), SCH_LINE::CanConnect(), SCH_NO_CONNECT::CanConnect(), SCH_SHEET::CanConnect(), SCH_SYMBOL::CanConnect(), PCB_POINT_EDITOR::chamferCorner(), SCH_EDIT_TOOL::ChangeTextType(), KI_TEST::CheckFootprint(), KI_TEST::CheckFpShape(), KI_TEST::CheckFpZone(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), CN_VISITOR::checkZoneItemConnection(), BOARD::ClassOf(), BOARD_CONNECTED_ITEM::ClassOf(), FOOTPRINT::ClassOf(), LIB_SYMBOL::ClassOf(), NETINFO_ITEM::ClassOf(), PAD::ClassOf(), PCB_ARC::ClassOf(), PCB_DIM_ALIGNED::ClassOf(), PCB_DIM_CENTER::ClassOf(), PCB_DIM_LEADER::ClassOf(), PCB_DIM_ORTHOGONAL::ClassOf(), PCB_DIM_RADIAL::ClassOf(), PCB_FIELD::ClassOf(), PCB_GENERATOR::ClassOf(), PCB_GROUP::ClassOf(), PCB_MARKER::ClassOf(), PCB_POINT::ClassOf(), PCB_REFERENCE_IMAGE::ClassOf(), PCB_SHAPE::ClassOf(), PCB_TABLE::ClassOf(), PCB_TABLECELL::ClassOf(), PCB_TARGET::ClassOf(), PCB_TEXT::ClassOf(), PCB_TEXTBOX::ClassOf(), PCB_TRACK::ClassOf(), PCB_VIA::ClassOf(), SCH_BITMAP::ClassOf(), SCH_BUS_BUS_ENTRY::ClassOf(), SCH_BUS_WIRE_ENTRY::ClassOf(), SCH_DIRECTIVE_LABEL::ClassOf(), SCH_FIELD::ClassOf(), SCH_GLOBALLABEL::ClassOf(), SCH_GROUP::ClassOf(), SCH_HIERLABEL::ClassOf(), SCH_JUNCTION::ClassOf(), SCH_LABEL::ClassOf(), SCH_LINE::ClassOf(), SCH_MARKER::ClassOf(), SCH_NO_CONNECT::ClassOf(), SCH_PIN::ClassOf(), SCH_SCREEN::ClassOf(), SCH_SHEET::ClassOf(), SCH_SHEET_PIN::ClassOf(), SCH_SYMBOL::ClassOf(), SCH_TABLE::ClassOf(), SCH_TABLECELL::ClassOf(), SCH_TEXT::ClassOf(), SCH_TEXTBOX::ClassOf(), ZONE::ClassOf(), MOCK_BOARD_ITEM::Clone(), TEST_EDA_ITEM::Clone(), CONNECTION_GRAPH::collectAllDriverValues(), SCH_EDIT_TOOL::collectUnits(), collidesWithArea(), LIB_SYMBOL::compare(), SCH_FIELD::compare(), SCH_ITEM::compare(), SCH_TEXT::compare(), SCH_TEXTBOX::compare(), TEARDROP_MANAGER::computeAnchorPoints(), EE_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_LINE::ConnectionPropagatesTo(), EE_RTREE::contains(), BOARD::ConvertKIIDsToCrossReferences(), SCHEMATIC::ConvertKIIDsToRefs(), SYMBOL_EDITOR_EDIT_TOOL::ConvertStackedPins(), FOOTPRINT::CopyFrom(), PAD::CopyFrom(), PCB_ARC::CopyFrom(), PCB_REFERENCE_IMAGE::CopyFrom(), PCB_SHAPE::CopyFrom(), PCB_TEXT::CopyFrom(), PCB_TEXTBOX::CopyFrom(), PCB_TRACK::CopyFrom(), PCB_VIA::CopyFrom(), ZONE::CopyFrom(), PAD_TOOL::copyPadSettings(), FOOTPRINT::CoverageRatio(), PNS_KICAD_IFACE::createBoardItem(), CreateItemForType(), BOARD_ADAPTER::createLayers(), CONVERT_TOOL::CreateLines(), PCB_BASE_FRAME::CreateNewFootprint(), ZONE_CREATE_HELPER::createNewZone(), BOARD_ADAPTER::createTrackWithMargin(), SCH_INSPECTION_TOOL::CrossProbe(), SCH_SCREEN::DeleteItem(), SCH_MARKER::DeserializeFromString(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), SCH_EDIT_TOOL::DoDelete(), APPEARANCE_CONTROLS::doesBoardItemNeedRebuild(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), EDIT_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawDimension(), KIGFX::SCH_PAINTER::drawItemBoundingBox(), SCH_DRAWING_TOOLS::DrawSheet(), DRAWING_TOOL::DrawVia(), CONNECTION_SUBGRAPH::driverName(), CN_ITEM::Dump(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM_DESC::EDA_ITEM_DESC(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_EDIT_TOOL::EditField(), SCH_EDIT_TOOL::editFieldText(), SYMBOL_EDITOR_EDIT_TOOL::editTextBoxProperties(), SYMBOL_EDITOR_EDIT_TOOL::editTextProperties(), enclosedByAreaFunc(), SCH_SELECTION_TOOL::EnterGroup(), CONNECTION_GRAPH::ercCheckBusToBusConflicts(), CONNECTION_GRAPH::ercCheckBusToBusEntryConflicts(), CONNECTION_GRAPH::ercCheckBusToNetConflicts(), CONNECTION_GRAPH::ercCheckDanglingWireEndpoints(), CONNECTION_GRAPH::ercCheckFloatingWires(), CONNECTION_GRAPH::ercCheckLabels(), CONNECTION_GRAPH::ercCheckMultipleDrivers(), CONNECTION_GRAPH::ercCheckNoConnects(), DRC_ENGINE::EvalRules(), DRC_ENGINE::EvalZoneConnection(), CONNECTION_GRAPH::ExchangeItem(), CONNECTION_SUBGRAPH::ExchangeItem(), SYMBOL_EDITOR_EDIT_TOOL::ExplodeStackedPin(), extractDiffPairCoupledItems(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), MULTICHANNEL_TOOL::findComponentsInRuleArea(), PCB_SELECTION_TOOL::FindItem(), NETLIST_EXPORTER_BASE::findNextSymbol(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), findParent(), MULTICHANNEL_TOOL::findRoutingInRuleArea(), EDIT_TOOL::Flip(), PCB_IO_KICAD_SEXPR::Format(), SCH_IO_KICAD_LEGACY::Format(), SCH_IO_KICAD_SEXPR::Format(), SCH_IO_KICAD_SEXPR::Format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), FormatProbeItem(), GetAllUsedFootprintLayers(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetBoard(), GetBoardItemWidth(), PCB_TRACK::GetBoundingBox(), SCH_LABEL_BASE::GetBoundingBox(), getBoundingBox(), getClosestGroup(), getClosestGroup(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), CONNECTIVITY_DATA::GetConnectedPadsAndVias(), FOOTPRINT::GetCoverageArea(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), CONNECTION_GRAPH::getDefaultConnection(), CONNECTION_SUBGRAPH::GetDriverPriority(), SCH_ITEM::GetEffectivePenWidth(), getFieldFunc(), PCB_TRACK::GetFriendlyName(), PCB_GROUP_TOOL::getGroupFromItem(), SCH_GROUP_TOOL::getGroupFromItem(), getHatchFillThermalClearance(), getHoleShape(), getInferredSymbols(), PCB_TRACK::GetItemDescription(), EE_GRID_HELPER::GetItemGrid(), PCB_GRID_HELPER::GetItemGrid(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), getMinDist(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_SCREEN::GetNeededJunctions(), CONNECTION_SUBGRAPH::GetNetclassesForDriver(), CONNECTIVITY_DATA::GetNetItems(), GetNetNavigatorItemText(), SCH_SYMBOL::GetPinPhysicalPosition(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_RULE_AREA::GetResolvedNetclasses(), GROUP_SEARCH_HANDLER::getResultCell(), LABEL_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), GetSchItemAsText(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), CONVERT_TOOL::getStartEndPoints(), KIGFX::SCH_PAINTER::getTextThickness(), GetTypeDesc(), PCBEXPR_COMPONENT_CLASS_REF::GetValue(), PCBEXPR_TYPE_REF::GetValue(), TEARDROP_MANAGER::GetWidth(), PCB_SELECTION_TOOL::grabUnconnected(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), API_HANDLER_PCB::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handleGetBoundingBox(), hasComponentClassFunc(), hash_fp_item(), SCH_SELECTION_TOOL::highlight(), BOARD_INSPECTION_TOOL::HighlightItem(), BOARD_INSPECTION_TOOL::highlightNet(), highlightNet(), SCH_FIELD::HitTest(), SCH_FIELD::HitTest(), SCH_LABEL_BASE::HitTest(), SCH_LABEL_BASE::HitTest(), SCH_LABEL_BASE::HitTest(), PCB_SELECTION_TOOL::hitTestDistance(), PCB_POINT_EDITOR::Init(), SCH_POINT_EDITOR::Init(), ROUTER_TOOL::InlineBreakTrack(), ROUTER_TOOL::InlineDrag(), DRC_RTREE::Insert(), EE_RTREE::insert(), GENERAL_COLLECTOR::Inspect(), SCH_COLLECTOR::Inspect(), TEST_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), isBlindBuriedViaFunc(), CONNECTIVITY_DATA::IsConnectedOnLayer(), isCopper(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), PCB_SELECTION_TOOL::isExpandableGraphicShape(), PNS_KICAD_IFACE_BASE::IsFlashedOnLayer(), PNS_KICAD_IFACE_BASE::IsFlashedOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::isFootprint(), BOARD_ITEM::IsGroupableType(), SCH_ITEM::IsGroupableType(), PNS_PCBNEW_RULE_RESOLVER::IsKeepout(), isKeepoutZone(), isMaskAperture(), isMicroVia(), PNS_PCBNEW_RULE_RESOLVER::IsNonPlatedSlot(), isNPTHPad(), PCB_TRACK::IsNull(), isNullAperture(), SCH_LINE::IsParallel(), isPlatedFunc(), TEARDROP_MANAGER::IsRound(), PNS::ROUTER::isStartingPointRoutable(), SCH_ITEM::IsType(), itemIsIncludedByFilter(), PCB_SELECTION_TOOL::itemPassesFilter(), SCH_SELECTION_TOOL::itemPassesFilter(), SCH_EDIT_TOOL::JustifyText(), CLIPBOARD_IO::LoadBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadHierarchicalSheetPins(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_SELECTION_TOOL::Main(), EDIT_POINTS_FACTORY::Make(), PCB_POINT_EDITOR::makePoints(), SCH_POINT_EDITOR::makePointsAndBehavior(), CONVERT_TOOL::makePolysFromChainedSegs(), SCH_SCREEN::MarkConnections(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), memberOfGroupFunc(), memberOfSheetFunc(), memberOfSheetOrChildrenFunc(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PNS_KICAD_IFACE::modifyBoardItem(), BOARD_EDITOR_CONTROL::modifyLockSelected(), SCH_MOVE_TOOL::moveItem(), SCH_SELECTION_TOOL::narrowSelection(), ARRAY_TOOL::onDialogClosed(), DIALOG_DRC::OnDRCItemSelected(), FOOTPRINT_EDIT_FRAME::OnEditItemRequest(), PCB_EDIT_FRAME::OnEditItemRequest(), DIALOG_GENERATORS::OnItemSelected(), EDA_3D_CANVAS::OnLeftDown(), EDA_3D_CANVAS::OnMouseMove(), SCH_EDIT_FRAME::onNetNavigatorSelection(), DIALOG_GENERATORS::OnRebuildTypeClick(), PCB_POINT_EDITOR::OnSelectionChange(), BOARD::cmp_drawings::operator()(), BOARD::cmp_items::operator()(), BOARD_ITEM::ptr_cmp::operator()(), CN_VISITOR::operator()(), FOOTPRINT::cmp_drawings::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), SCH_BUS_ENTRY_BASE::operator<(), SCH_FIELD::operator<(), SCH_ITEM::operator<(), SCH_JUNCTION::operator<(), SCH_LINE::operator<(), SCH_SHEET::operator<(), SCH_SYMBOL::operator<(), SCH_TABLE::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), PCB_REFERENCE_IMAGE::operator=(), SCH_BITMAP::operator=(), SCH_SHEET::operator=(), SCH_SYMBOL::operator=(), BOARD::operator==(), FOOTPRINT::operator==(), PAD::operator==(), PCB_ARC::operator==(), PCB_ARC::operator==(), PCB_DIMENSION_BASE::operator==(), PCB_FIELD::operator==(), PCB_GROUP::operator==(), PCB_POINT::operator==(), PCB_REFERENCE_IMAGE::operator==(), PCB_SHAPE::operator==(), PCB_SHAPE::operator==(), PCB_TABLE::operator==(), PCB_TABLECELL::operator==(), PCB_TARGET::operator==(), PCB_TEXT::operator==(), PCB_TEXTBOX::operator==(), PCB_TRACK::operator==(), PCB_VIA::operator==(), PCB_VIA::operator==(), SCH_BITMAP::operator==(), SCH_BUS_ENTRY_BASE::operator==(), SCH_FIELD::operator==(), SCH_GROUP::operator==(), SCH_ITEM::operator==(), SCH_JUNCTION::operator==(), SCH_LINE::operator==(), SCH_NO_CONNECT::operator==(), SCH_SHAPE::operator==(), SCH_SHEET::operator==(), SCH_SHEET_PIN::operator==(), SCH_SYMBOL::operator==(), SCH_TABLE::operator==(), SCH_TABLECELL::operator==(), SCH_TEXT::operator==(), SCH_TEXTBOX::operator==(), ZONE::operator==(), ZONE::operator==(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_SHAPE(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_IO_KICAD_SEXPR_PARSER::parseSchField(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), PCB_GROUP_TOOL::PickNewMember(), SCH_GROUP_TOOL::PickNewMember(), SCH_DRAWING_TOOLS::PlaceNextSymbolUnit(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotBoardGraphicItem(), OUTSET_ROUTINE::ProcessItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::processItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), BACK_ANNOTATE::processNetNameChange(), CONNECTION_GRAPH::processSubGraphs(), BOARD_COMMIT::propagateDamage(), SCH_EDIT_TOOL::Properties(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_EDIT_FRAME::PutDataInPreviousState(), EE_GRID_HELPER::queryVisible(), PCB_GRID_HELPER::queryVisible(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), PCB_SELECTION_TOOL::RebuildSelection(), SCHEMATIC::RecalculateConnections(), SCH_BASE_FRAME::RefreshZoomDependentItems(), GENERATOR_TOOL::RegenerateSelected(), PCB_CONTROL::rehatchBoardItem(), BOARD::Remove(), CN_CONNECTIVITY_ALGO::Remove(), FOOTPRINT::Remove(), KIGFX::PCB_VIEW::Remove(), SCH_SCREEN::Remove(), EE_RTREE::remove(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), LIB_SYMBOL::RemoveDrawItem(), SCH_BASE_FRAME::RemoveFromScreen(), CONNECTION_SUBGRAPH::RemoveItem(), PNS_KICAD_IFACE::RemoveItem(), SCH_SHEET::RemovePin(), SCH_EDIT_TOOL::RepeatDrawItem(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_SELECTION_TOOL::RequestSelection(), KI_TEST::RequireBoardItemWithTypeAndId(), CONNECTION_GRAPH::resolveAllDrivers(), SCHEMATIC::ResolveCrossReference(), CONNECTION_SUBGRAPH::ResolveDrivers(), BOARD::ResolveTextVar(), SCH_LABEL_BASE::ResolveTextVar(), DS_PROXY_UNDO_ITEM::Restore(), BOARD_COMMIT::Revert(), SCH_COMMIT::Revert(), PL_EDITOR_FRAME::RollbackFromUndo(), EDIT_TOOL::Rotate(), SCH_EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_TRACK_ANGLE::Run(), DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePin(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), CLIPBOARD_IO::SaveSelection(), PCB_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_EDIT_FRAME::SaveSelectionToDesignBlock(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveSymbolDrawItem(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR::saveText(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR::saveTextBox(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox(), SCH_FIELD::SCH_FIELD(), SCH_SCREEN::Schematic(), POWER_SEARCH_HANDLER::Search(), SYMBOL_SEARCH_HANDLER::Search(), TEXT_SEARCH_HANDLER::Search(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), SCH_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), PCB_SELECTION_TOOL::SelectMultiple(), PCB_SELECTION_TOOL::selectSameSheet(), PCB_SELECTION_TOOL::selectUnconnected(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_POINT_EDITOR::setAltConstraint(), ITEM_PICKER::SetItem(), SCH_LABEL_BASE::SetLabelShape(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), PCB_EDIT_FRAME::ShowFindDialog(), SCH_BASE_FRAME::ShowFindReplaceDialog(), FOOTPRINT::Similarity(), LIB_SYMBOL::Similarity(), PAD::Similarity(), PCB_ARC::Similarity(), PCB_BOARD_OUTLINE::Similarity(), PCB_DIMENSION_BASE::Similarity(), PCB_FIELD::Similarity(), PCB_GROUP::Similarity(), PCB_POINT::Similarity(), PCB_REFERENCE_IMAGE::Similarity(), PCB_SHAPE::Similarity(), PCB_TABLE::Similarity(), PCB_TABLECELL::Similarity(), PCB_TARGET::Similarity(), PCB_TEXT::Similarity(), PCB_TEXTBOX::Similarity(), PCB_TRACK::Similarity(), PCB_VIA::Similarity(), SCH_BITMAP::Similarity(), SCH_BUS_ENTRY_BASE::Similarity(), SCH_FIELD::Similarity(), SCH_GROUP::Similarity(), SCH_JUNCTION::Similarity(), SCH_LINE::Similarity(), SCH_NO_CONNECT::Similarity(), SCH_PIN::Similarity(), SCH_SHAPE::Similarity(), SCH_SHEET::Similarity(), SCH_SHEET_PIN::Similarity(), SCH_SYMBOL::Similarity(), SCH_TABLE::Similarity(), SCH_TABLECELL::Similarity(), SCH_TEXT::Similarity(), SCH_TEXTBOX::Similarity(), ZONE::Similarity(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), PNS::LINE_PLACER::Start(), EDIT_TOOL::Swap(), SCH_EDIT_TOOL::Swap(), SYMBOL_EDITOR_EDIT_TOOL::Swap(), FOOTPRINT::swapData(), PAD::swapData(), PCB_ARC::swapData(), PCB_DIM_ALIGNED::swapData(), PCB_DIM_CENTER::swapData(), PCB_DIM_LEADER::swapData(), PCB_DIM_ORTHOGONAL::swapData(), PCB_DIM_RADIAL::swapData(), PCB_FIELD::swapData(), PCB_GROUP::swapData(), PCB_POINT::swapData(), PCB_REFERENCE_IMAGE::swapData(), PCB_TABLE::swapData(), PCB_TABLECELL::swapData(), PCB_TARGET::swapData(), PCB_TEXT::swapData(), PCB_TEXTBOX::swapData(), PCB_TRACK::swapData(), PCB_TUNING_PATTERN::swapData(), PCB_VIA::swapData(), SCH_BITMAP::swapData(), SCH_FIELD::swapData(), SCH_GROUP::swapData(), SCH_JUNCTION::swapData(), SCH_NO_CONNECT::swapData(), SCH_SHEET::swapData(), SCH_SHEET_PIN::swapData(), SCH_SYMBOL::swapData(), SCH_TABLE::swapData(), ZONE::swapData(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTextItem(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testGraphicClearances(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), ERC_TESTER::TestMissingNetclasses(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), ERC_TESTER::TestTextVars(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_FIELD_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), PCB_TRACK::TransformShapeToPolygon(), SCH_LINE_WIRE_BUS_TOOL::TrimOverLappingWires(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), BOARD_COMMIT::undoLevelItem(), SCH_SELECTION_TOOL::unhighlight(), KIGFX::PCB_VIEW::Update(), KIGFX::SCH_VIEW::Update(), SCH_SHEET_PATH::UpdateAllScreenReferences(), DIALOG_FIELD_PROPERTIES::UpdateField(), CONNECTION_GRAPH::updateGenericItemConnectivity(), PCB_SHAPE::UpdateHatching(), SCH_BASE_FRAME::UpdateItem(), PCB_POINT_EDITOR::updateItem(), PL_POINT_EDITOR::updateItem(), PCB_CONTROL::UpdateMessagePanel(), EDIT_TOOL::updateModificationPoint(), PL_POINT_EDITOR::updatePoints(), PCB_PROPERTIES_PANEL::valueChanged(), SCH_PROPERTIES_PANEL::valueChanged(), SCH_BUS_ENTRY_BASE::ViewGetLayers(), SYMBOL::ViewGetLayers(), GERBER_DRAW_ITEM::Visit(), PCB_GROUP::Visit(), PCB_TRACK::Visit(), SCH_GROUP::Visit(), SCH_SHEET::Visit(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ UpdateDanglingState()

virtual bool SCH_ITEM::UpdateDanglingState ( std::vector< DANGLING_END_ITEM > & aItemListByType,
std::vector< DANGLING_END_ITEM > & aItemListByPos,
const SCH_SHEET_PATH * aSheet = nullptr )
inlinevirtualinherited

Test the schematic item to aItemList to check if it's dangling state has changed.

Note that the return value only true when the state of the test has changed. Use the IsDangling() method to get the current dangling state of the item. Some of the schematic objects cannot be tested for a dangling state, the default method always returns false. Only override the method if the item can be tested for a dangling state.

If aSheet is passed a non-null pointer to a SCH_SHEET_PATH, the overridden method can optionally use it to update sheet-local connectivity information

Parameters
aItemListByTypeis the list of items to test item against. It's sorted by item type, keeping WIRE_END pairs together.
aItemListByPosis the same list but sorted first by Y then by X.
aSheetis the sheet path to update connections for.
Returns
True if the dangling state has changed from it's current setting.

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

Definition at line 465 of file sch_item.h.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems().

◆ 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
aLayeris the current drawing layer.
aViewis a pointer to the VIEW device we are drawing on.

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

Definition at line 127 of file view_item.h.

References VIEW.

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

◆ ViewGetLayers()

std::vector< int > SCH_BITMAP::ViewGetLayers ( ) const
overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 205 of file sch_bitmap.cpp.

References LAYER_DRAW_BITMAPS, and LAYER_SELECTION_SHADOWS.

◆ ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD ( int aLayer,
const 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.

Use LOD_HIDE and LOD_SHOW constants to hide or show the item unconditionally.

Use lodScaleForThreshold() to calculate the LOD scale for when the item passes a certain threshold size on screen.

Parameters
aLayeris the current drawing layer.
aViewis a pointer to the VIEW device we are drawing on.
Returns
the level of detail. 0 always shows the item, because the actual zoom level (or VIEW scale) is always > 0

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

Definition at line 155 of file view_item.h.

References LOD_SHOW, and VIEW.

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

◆ viewPrivData()

◆ Visit()

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

May be re-implemented for each derived class in order to handle all the types given by its member data.

Implementations should call inspector->Inspect() on types in aScanTypes, and may use IterateForward() to do so on lists of such data.

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
aScanTypesWhich KICAD_T types are of interest and the order in which they should be processed.
Returns
#SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else #SCAN_CONTINUE, and determined by the inspector.

Reimplemented in BOARD, FOOTPRINT, GBR_LAYOUT, GERBER_DRAW_ITEM, GERBER_FILE_IMAGE, LIB_SYMBOL, PCB_GROUP, PCB_TABLE, PCB_TRACK, SCH_GROUP, SCH_LABEL_BASE, SCH_SHEET, SCH_SYMBOL, and SCH_TABLE.

Definition at line 127 of file eda_item.cpp.

References CONTINUE, KIGFX::VIEW_ITEM::GetClass(), IsType(), and QUIT.

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

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask)
inlineinherited

Definition at line 143 of file eda_item.h.

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

Friends And Related Symbol Documentation

◆ SCH_BITMAP_DESC

friend struct SCH_BITMAP_DESC
friend

Definition at line 122 of file sch_bitmap.h.

References SCH_BITMAP_DESC.

Referenced by SCH_BITMAP_DESC.

Member Data Documentation

◆ LOD_HIDE

◆ LOD_SHOW

◆ m_bodyStyle

◆ m_connected_items

std::map<SCH_SHEET_PATH, SCH_ITEM_VEC, SHEET_PATH_CMP> SCH_ITEM::m_connected_items
protectedinherited

Store pointers to other items that are connected to this one, per sheet.

Definition at line 748 of file sch_item.h.

Referenced by AddConnectionTo(), ClearConnectedItems(), ConnectedItems(), and SCH_LABEL_BASE::IsType().

◆ m_connection_map

std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*> SCH_ITEM::m_connection_map
protectedinherited

Store connectivity information, per sheet.

Definition at line 751 of file sch_item.h.

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

◆ m_connectivity_dirty

bool SCH_ITEM::m_connectivity_dirty
protectedinherited

Definition at line 753 of file sch_item.h.

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

◆ m_fieldsAutoplaced

◆ m_flags

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency
privateinherited

Additional transparency for diff'ing items.

Definition at line 210 of file view_item.h.

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

◆ m_forceVisible

◆ m_group

EDA_GROUP* EDA_ITEM::m_group
protectedinherited

The group this item belongs to, if any. No ownership implied.

Definition at line 529 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), GetParentGroup(), operator=(), SCH_LINE::SCH_LINE(), SetParentGroup(), and SCH_ITEM::SwapItemData().

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM
privateinherited

Definition at line 208 of file view_item.h.

Referenced by IsBOARD_ITEM(), and VIEW_ITEM().

◆ m_isRollover

bool EDA_ITEM::m_isRollover
protectedinherited

Definition at line 531 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), IsRollover(), operator=(), and SetIsRollover().

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM
privateinherited

Definition at line 207 of file view_item.h.

Referenced by IsSCH_ITEM(), and VIEW_ITEM().

◆ m_layer

◆ m_parent

◆ m_private

bool SCH_ITEM::m_private
protectedinherited

◆ m_referenceImage

◆ m_rule_areas_cache

std::unordered_set<SCH_RULE_AREA*> SCH_ITEM::m_rule_areas_cache
protectedinherited

Store pointers to rule areas which this item is contained within.

Definition at line 756 of file sch_item.h.

Referenced by AddRuleAreaToCache(), ClearRuleAreasCache(), SCH_SYMBOL::GetComponentClassNames(), GetRuleAreaCache(), ResolveDNP(), ResolveExcludedFromBoard(), ResolveExcludedFromBOM(), and ResolveExcludedFromSim().

◆ m_storedPos

VECTOR2I SCH_ITEM::m_storedPos
protectedinherited

Definition at line 744 of file sch_item.h.

Referenced by GetStoredPos(), and SetStoredPos().

◆ m_structType

KICAD_T EDA_ITEM::m_structType
privateinherited

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

See comment near SetType() regarding virtual functions.

Definition at line 524 of file eda_item.h.

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

◆ m_unit

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 516 of file eda_item.h.

Referenced by BOARD::Add(), SCH_RULE_AREA::addContainedItem(), SCH_RULE_AREA::addDirective(), SCH_SYMBOL::AddHierarchicalReference(), RC_ITEM::AddItem(), FIELDS_EDITOR_GRID_DATA_MODEL::AddReferences(), SCH_EDIT_FRAME::AnnotateSymbols(), FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), BOOST_FIXTURE_TEST_CASE(), BOARD::BulkRemoveStaleTeardrops(), SCH_SHEET_PATH::CheckForMissingSymbolInstances(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::ClearCell(), SCH_SHEET_PATH::Cmp(), SCH_ITEM::compare(), SCH_SHAPE::compare(), SCHEMATIC::ConvertRefsToKIIDs(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::createActualDerivedSymbol(), SCHEMATIC::CreateDefaultScreens(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::CreateDerivedSymbol(), MICROWAVE_TOOL::createMicrowaveInductor(), FOOTPRINT::Deserialize(), PAD::Deserialize(), PCB_ARC::Deserialize(), PCB_DIMENSION_BASE::Deserialize(), PCB_GROUP::Deserialize(), PCB_SHAPE::Deserialize(), PCB_TEXT::Deserialize(), PCB_TEXTBOX::Deserialize(), PCB_TRACK::Deserialize(), PCB_VIA::Deserialize(), SCH_LABEL::Deserialize(), SCH_LINE::Deserialize(), ZONE::Deserialize(), SCH_MARKER::DeserializeFromString(), ZONE_FILLER_TOOL::DirtyZone(), DRAWING_TOOL::DrawVia(), BOARD_ITEM::Duplicate(), FOOTPRINT::Duplicate(), LIB_SYMBOL::Duplicate(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), EDA_ITEM(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), NETLIST_EXPORTER_ALLEGRO::extractComponentsInfo(), BOARD::FillItemMap(), SCH_SHEET_LIST::FillItemMap(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), MULTICHANNEL_TOOL::findRoutingInRuleArea(), KIGIT_PCB_MERGE::findSetDifferences(), SCH_EDITOR_CONTROL::FindSymbolAndItem(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), SCH_IO_KICAD_SEXPR::Format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), SCH_PIN::GetDefaultNetName(), RC_ITEM::GetJsonViolation(), PAD::GetMsgPanelInfo(), DIALOG_BOARD_REANNOTATE::GetNewRefDes(), PCB_MARKER::GetUUID(), SCH_MARKER::GetUUID(), FIELDS_EDITOR_GRID_DATA_MODEL::GetValue(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::GetValue(), FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::groupMatch(), ZONE::HigherPriority(), SCH_SHEET_PATH::IsContainedWithin(), PCB_IO_KICAD_LEGACY::loadFOOTPRINT(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), PCB_EDIT_FRAME::LoadFootprints(), SCH_IO_KICAD_LEGACY::loadHierarchy(), PCB_IO_KICAD_LEGACY::loadPCB_TARGET(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), EESCHEMA_HELPERS::LoadSchematic(), SCH_IO_CADSTAR_ARCHIVE::LoadSchematicFile(), SCH_IO_EASYEDA::LoadSchematicFile(), SCH_IO_EASYEDAPRO::LoadSchematicFile(), SCH_IO_LTSPICE::LoadSchematicFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), PCB_IO_KICAD_LEGACY::loadTrackList(), NETLIST_EXPORTER_XML::makeSymbols(), SCH_EDIT_FRAME::mapExistingAnnotation(), DIALOG_DRC::OnDRCItemSelected(), BOARD::cmp_drawings::operator()(), BOARD::cmp_items::operator()(), BOARD_ITEM::ptr_cmp::operator()(), CompareByUuid::operator()(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), FOOTPRINT::cmp_zones::operator()(), PCB_SHAPE::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), SCH_SYMBOL::operator<(), PAD::operator==(), SCH_FIELD::operator==(), PAD::PAD(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), SCH_IO_KICAD_SEXPR_PARSER::parseSchTextBoxContent(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), SCH_EDITOR_CONTROL::Paste(), SCH_SHEET_PATH::PathAsString(), PCB_VIA::PCB_VIA(), PCB_CONTROL::placeBoardItems(), processTextItem(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::Remove(), SCH_SYMBOL::RemoveInstance(), FIELDS_EDITOR_GRID_DATA_MODEL::RemoveSymbol(), FIELDS_EDITOR_GRID_DATA_MODEL::RenameColumn(), SCH_SCREENS::ReplaceDuplicateTimeStamps(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), BOARD::ResolveItem(), SCH_SHEET_PATH::ResolveItem(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::RevertRow(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), SCH_IO_KICAD_SEXPR::saveBitmap(), SCH_IO_KICAD_SEXPR::saveBusEntry(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_IO_KICAD_SEXPR::saveGroup(), SCH_IO_KICAD_SEXPR::saveJunction(), SCH_IO_KICAD_SEXPR::saveLine(), SCH_IO_KICAD_SEXPR::saveNoConnect(), SCH_EDIT_FRAME::SaveProject(), SCH_IO_KICAD_SEXPR::saveShape(), SCH_IO_KICAD_LEGACY::saveSheet(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_LEGACY::saveSymbol(), SCH_IO_KICAD_SEXPR::saveSymbol(), SCH_IO_KICAD_SEXPR::saveTable(), SCH_IO_KICAD_SEXPR::saveText(), SCH_IO_KICAD_SEXPR::saveTextBox(), SCH_PIN::SCH_PIN(), SCH_REFERENCE::SCH_REFERENCE(), SCH_SHEET::SCH_SHEET(), SCH_SYMBOL::SCH_SYMBOL(), FOOTPRINT::Serialize(), PAD::Serialize(), PCB_ARC::Serialize(), PCB_DIMENSION_BASE::Serialize(), PCB_GROUP::Serialize(), PCB_SHAPE::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TRACK::Serialize(), PCB_VIA::Serialize(), SCH_LABEL::Serialize(), SCH_LINE::Serialize(), ZONE::Serialize(), SCH_MARKER::SerializeToString(), RC_ITEM::SetItems(), SCH_EDITOR_CONTROL::setPastedSymbolInstances(), FIELDS_EDITOR_GRID_DATA_MODEL::SetValue(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::SetValue(), LIB_SYMBOL::Similarity(), PAD::Similarity(), PCB_DIMENSION_BASE::Similarity(), PCB_FIELD::Similarity(), SCH_BITMAP::Similarity(), SCH_BUS_ENTRY_BASE::Similarity(), SCH_FIELD::Similarity(), SCH_JUNCTION::Similarity(), SCH_LABEL_BASE::Similarity(), SCH_LINE::Similarity(), SCH_NO_CONNECT::Similarity(), SCH_PIN::Similarity(), SCH_SHAPE::Similarity(), SCH_TEXT::Similarity(), SCH_TEXTBOX::Similarity(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_SHEET_LIST::SortByHierarchicalPageNumbers(), SCH_SYMBOL::SyncOtherUnits(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), testGroupEqual(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), DIALOG_LIB_FIELDS_TABLE::TransferDataFromWindow(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField(), LIB_FIELDS_EDITOR_GRID_DATA_MODEL::updateDataStoreSymbolField(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), PCB_CONTROL::UpdateMessagePanel(), PL_EDITOR_CONTROL::UpdateMessagePanel(), SCH_INSPECTION_TOOL::UpdateMessagePanel(), SCH_EDITOR_CONTROL::updatePastedSheet(), SCH_EDITOR_CONTROL::updatePastedSymbol(), BOARD::UpdateRatsnestExclusions(), SCH_SHEET_LIST::UpdateSymbolInstanceData(), NETLIST_EXPORTER_CADSTAR::WriteNetlist(), and NETLIST_EXPORTER_ORCADPCB2::WriteNetlist().

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData
privateinherited

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