KiCad PCB EDA Suite
VIA Class Reference

#include <track.h>

Inheritance diagram for VIA:
TRACK BOARD_CONNECTED_ITEM BOARD_ITEM EDA_ITEM KIGFX::VIEW_ITEM INSPECTABLE

Public Member Functions

 VIA (BOARD_ITEM *aParent)
 
bool IsType (const KICAD_T aScanTypes[]) const override
 Check whether the item is one of the listed types. More...
 
VIATYPE GetViaType () const
 
void SetViaType (VIATYPE aViaType)
 
bool IsOnLayer (PCB_LAYER_ID aLayer) const override
 Test to see if this object is on the given layer. More...
 
virtual LSET GetLayerSet () const override
 Return a std::bitset of all layers on which the item physically resides. More...
 
virtual void SetLayerSet (LSET aLayers) override
 
void SetLayerPair (PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer)
 Function SetLayerPair For a via m_layer contains the top layer, the other layer is in m_bottomLayer. More...
 
void SetBottomLayer (PCB_LAYER_ID aLayer)
 
void SetTopLayer (PCB_LAYER_ID aLayer)
 
void LayerPair (PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
 Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between these 2 layers) More...
 
PCB_LAYER_ID TopLayer () const
 
PCB_LAYER_ID BottomLayer () const
 
void SanitizeLayers ()
 Function SanitizeLayers Check so that the layers are correct dependin on the type of via, and so that the top actually is on top. More...
 
wxPoint GetPosition () const override
 
void SetPosition (const wxPoint &aPoint) override
 
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. More...
 
bool HitTest (const wxPoint &aPosition, int aAccuracy=0) const override
 Test if aPosition is contained within or on the bounding box of an item. More...
 
bool HitTest (const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
 Test if aRect intersects or is contained within the bounding box of an item. More...
 
wxString GetClass () const override
 Return the class name. More...
 
wxString GetSelectMenuText (EDA_UNITS aUnits) const override
 Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...
 
BITMAP_DEF GetMenuImage () const override
 Return a pointer to an image to be used in menus. More...
 
EDA_ITEMClone () const override
 Create a duplicate of this item with linked list members set to NULL. More...
 
void ViewGetLayers (int aLayers[], int &aCount) const override
 Return the all the layers within the VIEW the object is painted on. More...
 
double ViewGetLOD (int aLayer, KIGFX::VIEW *aView) const override
 Return the level of detail (LOD) of the item. More...
 
void Flip (const wxPoint &aCentre, bool aFlipLeftRight) override
 Flip this object, i.e. More...
 
int GetMinAnnulus (PCB_LAYER_ID aLayer, wxString *aSource) const
 
void SetRemoveUnconnected (bool aSet)
 Sets the unconnected removal property. More...
 
bool GetRemoveUnconnected () const
 
void SetKeepTopBottom (bool aSet)
 Sets whether we keep the top and bottom connections even if they are not connected. More...
 
bool GetKeepTopBottom () const
 
bool FlashLayer (int aLayer) const
 Checks to see whether the via should have a pad on the specific layer. More...
 
bool FlashLayer (LSET aLayers) const
 Checks to see if the via is present on any of the layers in the set. More...
 
void SetDrill (int aDrill)
 Function SetDrill sets the drill value for vias. More...
 
int GetDrill () const
 Function GetDrill returns the local drill setting for this VIA. More...
 
int GetDrillValue () const
 Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value for the board. More...
 
void SetDrillDefault ()
 Function SetDrillDefault sets the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER. More...
 
bool GetIsFree () const
 Checks if the via is a free via (as opposed to one created on a track by the router). More...
 
void SetIsFree (bool aFree=true)
 
bool IsDrillDefault () const
 Function IsDrillDefault. More...
 
void SwapData (BOARD_ITEM *aImage) override
 Swap data between aItem and aImage. More...
 
std::shared_ptr< SHAPEGetEffectiveShape (PCB_LAYER_ID aLayer=UNDEFINED_LAYER) const override
 Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes. More...
 
void Move (const wxPoint &aMoveVector) override
 Move this object. More...
 
void Move (const VECTOR2I &aMoveVector)
 
void Rotate (const wxPoint &aRotCentre, double aAngle) override
 Rotate this object. More...
 
void Rotate (const VECTOR2I &aRotCentre, double aAngle)
 
void Flip (const VECTOR2I &aCentre, bool aFlipLeftRight)
 
const wxPoint GetFocusPosition () const override
 Similar to GetPosition, but allows items to return their visual center rather than their anchor. More...
 
void SetWidth (int aWidth)
 
int GetWidth () const
 
void SetEnd (const wxPoint &aEnd)
 
const wxPoint & GetEnd () const
 
void SetStart (const wxPoint &aStart)
 
const wxPoint & GetStart () const
 
void SetEndX (int aX)
 
void SetEndY (int aY)
 
int GetEndX () const
 
int GetEndY () const
 
const wxPoint & GetEndPoint (ENDPOINT_T aEndPoint) const
 Return the selected endpoint (start or end) More...
 
const EDA_RECT GetBoundingBox () const override
 Return the orthogonal bounding box of this object for display purposes. More...
 
virtual double GetLength () const
 Function GetLength returns the length of the track using the hypotenuse calculation. More...
 
void TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
 Function TransformShapeWithClearanceToPolygon Convert the track shape to a closed polygon Used in filling zones calculations Circles (vias) and arcs (ends of tracks) are approximated by segments. More...
 
STATUS_FLAGS IsPointOnEnds (const wxPoint &point, int min_dist=0) const
 Function IsPointOnEnds returns STARTPOINT if point if near (dist = min_dist) start point, ENDPOINT if point if near (dist = min_dist) end point,STARTPOINT|ENDPOINT if point if near (dist = min_dist) both ends, or 0 if none of the above. More...
 
bool IsNull () const
 Function IsNull returns true if segment length is zero. More...
 
SEARCH_RESULT Visit (INSPECTOR inspector, void *testData, const KICAD_T scanTypes[]) override
 May be re-implemented for each derived class in order to handle all the types given by its member data. More...
 
bool ApproxCollinear (const TRACK &aTrack)
 
int GetLocalClearance (wxString *aSource) const override
 Function GetLocalClearance returns any local clearance overrides set in the "classic" (ie: pre-rule) system. More...
 
void GetWidthConstraints (int *aMin, int *aMax, wxString *aSource) const
 
const BOX2I ViewBBox () const override
 Return the bounding box of the item covering all its layers. More...
 
bool IsOnCopperLayer () const override
 
bool IsConnected () const override
 Returns information if the object is derived from BOARD_CONNECTED_ITEM. More...
 
NETINFO_ITEMGetNet () const
 Return #NET_INFO object for a given item. More...
 
void SetNet (NETINFO_ITEM *aNetInfo)
 Set a NET_INFO object for the item. More...
 
int GetNetCode () const
 
bool SetNetCode (int aNetCode, bool aNoAssert)
 Set net using a net code. More...
 
void SetNetCode (int aNetCode)
 
wxString GetNetname () const
 
wxString GetNetnameMsg () const
 
wxString GetShortNetname () const
 
virtual int GetOwnClearance (PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
 Return an item's "own" clearance in internal units. More...
 
virtual int GetLocalClearanceOverrides (wxString *aSource) const
 Return any local clearance overrides set in the "classic" (ie: pre-rule) system. More...
 
virtual NETCLASSGetNetClass () const
 Return the NETCLASS for this item. More...
 
virtual NETCLASSGetEffectiveNetclass () const
 Return the NETCLASS for this item, or the default netclass if none is defined. More...
 
virtual wxString GetNetClassName () const
 Returns the netclass of the zone. More...
 
void SetLocalRatsnestVisible (bool aVisible)
 
bool GetLocalRatsnestVisible () const
 
void SetParentGroup (PCB_GROUP *aGroup)
 
PCB_GROUPGetParentGroup () const
 
int GetX () const
 
int GetY () const
 
virtual wxPoint GetCenter () const
 This defaults to the center of the bounding box if not overridden. More...
 
void SetX (int aX)
 
void SetY (int aY)
 
BOARD_ITEM_CONTAINERGetParent () const
 
virtual PCB_LAYER_ID GetLayer () const
 Return the primary layer this item is on. More...
 
virtual void SetLayer (PCB_LAYER_ID aLayer)
 Set the layer this item is on. More...
 
virtual BOARD_ITEMDuplicate () const
 Create a copy of a of this BOARD_ITEM. More...
 
bool IsTrack () const
 Test to see if this object is a track or via (or microvia). More...
 
virtual bool IsLocked () const
 
virtual void SetLocked (bool aLocked)
 Modify the 'lock' status for of the item. More...
 
void DeleteStructure ()
 Delete this object after removing from its parent if it has one. More...
 
virtual BOARDGetBoard () const
 Return the BOARD in which this BOARD_ITEM resides, or NULL if none. More...
 
wxString GetLayerName () const
 Return the name of the PCB layer on which the item resides. More...
 
KICAD_T Type () const
 Returns the type of object. More...
 
virtual void SetParent (EDA_ITEM *aParent)
 
bool IsModified () const
 
bool IsNew () const
 
bool IsMoving () const
 
bool IsDragging () const
 
bool IsWireImage () const
 
bool IsSelected () const
 
bool IsEntered () const
 
bool IsResized () const
 
bool IsBrightened () const
 
void SetWireImage ()
 
void SetSelected ()
 
void SetBrightened ()
 
void ClearSelected ()
 
void ClearBrightened ()
 
void SetModified ()
 
int GetState (int type) const
 
void SetState (int type, bool state)
 
STATUS_FLAGS GetStatus () const
 
void SetStatus (STATUS_FLAGS aStatus)
 
void SetFlags (STATUS_FLAGS aMask)
 
void ClearFlags (STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
 
STATUS_FLAGS GetFlags () const
 
bool HasFlag (STATUS_FLAGS aFlag) const
 
STATUS_FLAGS GetEditFlags () const
 
void ClearTempFlags ()
 
void ClearEditFlags ()
 
void SetForceVisible (bool aEnable)
 Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible. More...
 
bool IsForceVisible () const
 
virtual bool Matches (const wxFindReplaceData &aSearchData, void *aAuxData) const
 Compare the item against the search criteria in aSearchData. More...
 
virtual bool Replace (const wxFindReplaceData &aSearchData, void *aAuxData=nullptr)
 Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace. More...
 
virtual bool IsReplaceable () const
 Override this method in any derived object that supports test find and replace. More...
 
bool operator< (const EDA_ITEM &aItem) const
 Test if another item is less than this object. More...
 
virtual void ViewDraw (int aLayer, VIEW *aView) const
 Draw the parts of the object belonging to layer aLayer. More...
 
VIEW_ITEM_DATA * viewPrivData () const
 
void ClearViewPrivData ()
 
bool Set (PROPERTY_BASE *aProperty, wxAny &aValue)
 
template<typename T >
bool Set (PROPERTY_BASE *aProperty, T aValue)
 
template<typename T >
bool Set (const wxString &aProperty, T aValue)
 
wxAny Get (PROPERTY_BASE *aProperty)
 
template<typename T >
Get (PROPERTY_BASE *aProperty)
 
template<typename T >
boost::optional< T > Get (const wxString &aProperty)
 

Static Public Member Functions

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

Public Attributes

const KIID m_Uuid
 

Static Public Attributes

static wxPoint ZeroOffset
 A value of wxPoint(0,0) which can be passed to the Draw() functions. More...
 

Protected Member Functions

wxString layerMaskDescribe () const override
 Return a string (to be shown to the user) describing a layer mask. More...
 
void GetMsgPanelInfoBase_Common (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) const
 
bool Matches (const wxString &aText, const wxFindReplaceData &aSearchData) const
 Compare aText against search criteria in aSearchData. More...
 

Protected Attributes

int m_Width
 Thickness of track, or via diameter. More...
 
wxPoint m_Start
 Line start point. More...
 
wxPoint m_End
 Line end point. More...
 
NETINFO_ITEMm_netinfo
 Store all information about the net that item belongs to. More...
 
PCB_LAYER_ID m_layer
 
PCB_GROUPm_group
 
STATUS_FLAGS m_status
 
EDA_ITEMm_parent
 Linked list: Link (parent struct) More...
 
bool m_forceVisible
 
STATUS_FLAGS m_flags
 

Private Attributes

PCB_LAYER_ID m_bottomLayer
 The bottom layer of the via (the top layer is in m_layer) More...
 
VIATYPE m_viaType
 through, blind/buried or micro More...
 
int m_drill
 for vias: via drill (- 1 for default value) More...
 
bool m_removeUnconnectedLayer
 Remove unconnected copper on a via. More...
 
bool m_keepTopBottomLayer
 Keep the top and bottom annular rings. More...
 
bool m_isFree
 "Free" vias don't get their nets auto-updated More...
 

Detailed Description

Definition at line 343 of file track.h.

Constructor & Destructor Documentation

◆ VIA()

VIA::VIA ( BOARD_ITEM aParent)

Definition at line 66 of file track.cpp.

66  :
67  TRACK( aParent, PCB_VIA_T )
68 {
73  m_keepTopBottomLayer = true;
74  m_isFree = false;
75 }
bool m_isFree
"Free" vias don't get their nets auto-updated
Definition: track.h:529
bool m_keepTopBottomLayer
Keep the top and bottom annular rings.
Definition: track.h:528
void SetDrillDefault()
Function SetDrillDefault sets the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER.
Definition: track.h:495
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
TRACK(BOARD_ITEM *aParent, KICAD_T idtype=PCB_TRACE_T)
Definition: track.cpp:47
void SetViaType(VIATYPE aViaType)
Definition: track.h:374
PCB_LAYER_ID m_bottomLayer
The bottom layer of the via (the top layer is in m_layer)
Definition: track.h:521
bool m_removeUnconnectedLayer
Remove unconnected copper on a via.
Definition: track.h:527

References B_Cu, m_bottomLayer, m_isFree, m_keepTopBottomLayer, m_removeUnconnectedLayer, SetDrillDefault(), SetViaType(), and THROUGH.

Referenced by Clone().

Member Function Documentation

◆ ApproxCollinear()

bool TRACK::ApproxCollinear ( const TRACK aTrack)
inlineinherited

Definition at line 190 of file track.h.

191  {
192  SEG a( m_Start, m_End );
193  SEG b( aTrack.GetStart(), aTrack.GetEnd() );
194  return a.ApproxCollinear( b );
195  }
wxPoint m_Start
Line start point.
Definition: track.h:256
const wxPoint & GetStart() const
Definition: track.h:116
wxPoint m_End
Line end point.
Definition: track.h:257
bool ApproxCollinear(const SEG &aSeg) const
Definition: seg.h:269
Definition: seg.h:41
const wxPoint & GetEnd() const
Definition: track.h:113

References SEG::ApproxCollinear(), TRACK::GetEnd(), TRACK::GetStart(), TRACK::m_End, and TRACK::m_Start.

◆ BottomLayer()

PCB_LAYER_ID VIA::BottomLayer ( ) const

Definition at line 463 of file track.cpp.

464 {
465  return m_bottomLayer;
466 }
PCB_LAYER_ID m_bottomLayer
The bottom layer of the via (the top layer is in m_layer)
Definition: track.h:521

References m_bottomLayer.

Referenced by CN_LIST::Add(), DIALOG_NET_INSPECTOR::calculateViaLength(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PNS_KICAD_IFACE_BASE::syncVia(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ ClassOf()

static bool VIA::ClassOf ( const EDA_ITEM aItem)
inlinestatic

Definition at line 348 of file track.h.

349  {
350  return aItem && PCB_VIA_T == aItem->Type();
351  }
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162

References PCB_VIA_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )
inlineinherited

◆ ClearEditFlags()

◆ ClearFlags()

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

Definition at line 203 of file eda_item.h.

203 { m_flags &= ~aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildPolyCourtyards(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), EE_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::narrowSelection(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DRAWING_TOOL::PlaceText(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDITOR_PIN_TOOL::RepeatPin(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), SCH_EDIT_FRAME::SaveCopyForRepeatItem(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ ClearSelected()

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )
inlineinherited

Definition at line 215 of file eda_item.h.

216  {
218  DO_NOT_DRAW );
219  }
#define TEMP_SELECTED
flag indicating that the structure has already selected
Definition: eda_item.h:114
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
Definition: eda_item.h:103
#define CANDIDATE
flag indicating that the structure is connected
Definition: eda_item.h:116
#define DO_NOT_DRAW
Used to disable draw function.
Definition: eda_item.h:118
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: eda_item.h:111
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:203
#define ENDPOINT
ends. (Used to support dragging.)
Definition: eda_item.h:112
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:117

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

Referenced by SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )
inlineinherited

Definition at line 148 of file view_item.h.

149  {
150  m_viewPrivData = nullptr;
151  }
VIEW_ITEM_DATA * m_viewPrivData
Definition: view_item.h:156

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * VIA::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 TRACK.

Definition at line 78 of file track.cpp.

79 {
80  return new VIA( *this );
81 }
VIA(BOARD_ITEM *aParent)
Definition: track.cpp:66

References VIA().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )
inherited

Delete this object after removing from its parent if it has one.

Definition at line 113 of file board_item.cpp.

114 {
115  BOARD_ITEM_CONTAINER* parent = GetParent();
116 
117  if( parent )
118  parent->Remove( this );
119 
120  delete this;
121 }
virtual void Remove(BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL)=0
Removes an item from the container.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:168

References BOARD_ITEM::GetParent(), and BOARD_ITEM_CONTAINER::Remove().

Referenced by BOARD::PadDelete(), and DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Duplicate()

virtual BOARD_ITEM* BOARD_ITEM::Duplicate ( ) const
inlinevirtualinherited

Create a copy of a of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 202 of file board_item.h.

203  {
204  EDA_ITEM* dupe = Clone();
205  const_cast<KIID&>( dupe->m_Uuid ) = KIID();
206 
207  return static_cast<BOARD_ITEM*>( dupe );
208  }
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:97
Definition: kiid.h:44
const KIID m_Uuid
Definition: eda_item.h:524
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:149

References EDA_ITEM::Clone(), and EDA_ITEM::m_Uuid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDIT_TOOL::Duplicate(), and ARRAY_CREATOR::Invoke().

◆ FlashLayer() [1/2]

bool VIA::FlashLayer ( int  aLayer) const

Checks to see whether the via should have a pad on the specific layer.

Parameters
aLayerLayer to check for connectivity
Returns
true if connected by pad or track (or optionally zone)

Definition at line 494 of file track.cpp.

495 {
496  std::vector<KICAD_T> types
498 
499  // Return the "normal" shape if the caller doesn't specify a particular layer
500  if( aLayer == UNDEFINED_LAYER )
501  return true;
502 
503  BOARD* board = GetBoard();
504 
505  if( !board )
506  return false;
507 
508  if( !IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) ) )
509  return false;
510 
512  return true;
513 
514  if( m_keepTopBottomLayer && ( aLayer == m_layer || aLayer == m_bottomLayer ) )
515  return true;
516 
517  return board->GetConnectivity()->IsConnectedOnLayer( this, static_cast<int>( aLayer ),
518  types );
519 }
class ARC, an arc track segment on a copper layer
Definition: typeinfo.h:97
class PAD, a pad in a footprint
Definition: typeinfo.h:89
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
bool m_keepTopBottomLayer
Keep the top and bottom annular rings.
Definition: track.h:528
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:414
class ZONE, a copper pour area
Definition: typeinfo.h:105
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
class ZONE, managed by a footprint
Definition: typeinfo.h:94
PCB_LAYER_ID m_layer
Definition: board_item.h:363
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
Definition: track.cpp:361
PCB_LAYER_ID m_bottomLayer
The bottom layer of the via (the top layer is in m_layer)
Definition: track.h:521
bool m_removeUnconnectedLayer
Remove unconnected copper on a via.
Definition: track.h:527

References BOARD_ITEM::GetBoard(), BOARD::GetConnectivity(), IsOnLayer(), m_bottomLayer, m_keepTopBottomLayer, BOARD_ITEM::m_layer, m_removeUnconnectedLayer, PCB_ARC_T, PCB_FP_ZONE_T, PCB_PAD_T, PCB_TRACE_T, PCB_ZONE_T, and UNDEFINED_LAYER.

Referenced by ZONE_FILLER::buildCopperItemClearances(), BOARD_ADAPTER::createLayers(), KIGFX::PCB_PAINTER::draw(), FlashLayer(), GetMinAnnulus(), PNS_KICAD_IFACE::IsFlashedOnLayer(), PlotStandardLayer(), and ViewGetLOD().

◆ FlashLayer() [2/2]

bool VIA::FlashLayer ( LSET  aLayers) const

Checks to see if the via is present on any of the layers in the set.

Parameters
aLayersset of layers to check the via against
Returns
true if connected by pad or track (or optionally zone) on any of the associated layers

Definition at line 482 of file track.cpp.

483 {
484  for( auto layer : aLayers.Seq() )
485  {
486  if( FlashLayer( layer ) )
487  return true;
488  }
489 
490  return false;
491 }
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:411
bool FlashLayer(int aLayer) const
Checks to see whether the via should have a pad on the specific layer.
Definition: track.cpp:494

References FlashLayer(), and LSET::Seq().

◆ Flip() [1/2]

void BOARD_ITEM::Flip ( const VECTOR2I aCentre,
bool  aFlipLeftRight 
)
inlineinherited

Definition at line 315 of file board_item.h.

316  {
317  Flip( wxPoint( aCentre.x, aCentre.y ), aFlipLeftRight );
318  }
virtual void Flip(const wxPoint &aCentre, bool aFlipLeftRight)
Flip this object, i.e.
Definition: board_item.h:310

References BOARD_ITEM::Flip(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Flip() [2/2]

void VIA::Flip ( const wxPoint &  aCentre,
bool  aFlipLeftRight 
)
overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters
aCentrethe rotation point.
aFlipLeftRightmirror across Y axis instead of X (the default).

Reimplemented from TRACK.

Definition at line 319 of file track.cpp.

320 {
321  if( aFlipLeftRight )
322  {
323  m_Start.x = aCentre.x - ( m_Start.x - aCentre.x );
324  m_End.x = aCentre.x - ( m_End.x - aCentre.x );
325  }
326  else
327  {
328  m_Start.y = aCentre.y - ( m_Start.y - aCentre.y );
329  m_End.y = aCentre.y - ( m_End.y - aCentre.y );
330  }
331 
332  if( GetViaType() != VIATYPE::THROUGH )
333  {
334  int copperLayerCount = GetBoard()->GetCopperLayerCount();
335  PCB_LAYER_ID top_layer;
336  PCB_LAYER_ID bottom_layer;
337  LayerPair( &top_layer, &bottom_layer );
338  top_layer = FlipLayer( top_layer, copperLayerCount );
339  bottom_layer = FlipLayer( bottom_layer, copperLayerCount );
340  SetLayerPair( top_layer, bottom_layer );
341  }
342 }
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between thes...
Definition: track.cpp:435
wxPoint m_Start
Line start point.
Definition: track.h:256
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Definition: lset.cpp:521
PCB_LAYER_ID
A quick note on layer IDs:
wxPoint m_End
Line end point.
Definition: track.h:257
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
void SetLayerPair(PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer)
Function SetLayerPair For a via m_layer contains the top layer, the other layer is in m_bottomLayer.
Definition: track.cpp:414
int GetCopperLayerCount() const
Definition: board.cpp:435
VIATYPE GetViaType() const
Definition: track.h:373

References FlipLayer(), BOARD_ITEM::GetBoard(), BOARD::GetCopperLayerCount(), GetViaType(), LayerPair(), TRACK::m_End, TRACK::m_Start, SetLayerPair(), and THROUGH.

◆ Get() [1/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE aProperty)
inlineinherited

Definition at line 84 of file inspectable.h.

85  {
87  TYPE_ID thisType = TYPE_HASH( *this );
88  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
89  return object ? aProperty->getter( object ) : wxAny();
90  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual wxAny getter(void *aObject) const =0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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

Referenced by CLASS_D_DESC::CLASS_D_DESC(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [2/3]

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

Definition at line 93 of file inspectable.h.

94  {
96  TYPE_ID thisType = TYPE_HASH( *this );
97  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
98  return object ? aProperty->get<T>( object ) : T();
99  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
T get(void *aObject)
Definition: property.h:266
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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

◆ Get() [3/3]

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

Definition at line 102 of file inspectable.h.

103  {
105  TYPE_ID thisType = TYPE_HASH( *this );
106  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
107  boost::optional<T> ret;
108 
109  if( prop )
110  {
111  void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
112 
113  if( object )
114  ret = prop->get<T>( object );
115  }
116 
117  return ret;
118  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
T get(void *aObject)
Definition: property.h:266
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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

◆ GetBoard()

BOARD * BOARD_ITEM::GetBoard ( ) const
virtualinherited

Return the BOARD in which this BOARD_ITEM resides, or NULL if none.

Definition at line 46 of file board_item.cpp.

47 {
48  if( Type() == PCB_T )
49  return (BOARD*) this;
50 
51  BOARD_ITEM* parent = GetParent();
52 
53  if( parent )
54  return parent->GetBoard();
55 
56  return NULL;
57 }
Definition: typeinfo.h:84
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:82
#define NULL
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:168
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParent(), NULL, PCB_T, and EDA_ITEM::Type().

Referenced by PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), KIGFX::PCB_PAINTER::draw(), exprFromTo(), FlashLayer(), PAD::FlashLayer(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), TRACK::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), DIMENSION_BASE::Flip(), ARC::Flip(), PCB_SHAPE::Flip(), Flip(), ZONE::Flip(), BOARD_ITEM::GetBoard(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), ZONE::GetInteractingZones(), BOARD_ITEM::GetLayerName(), GetMinAnnulus(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), ZONE::GetSelectMenuText(), DRC_ENGINE::GetShape(), FP_TEXT::GetShownText(), PAD::GetSolderMaskMargin(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), TRACK::GetWidthConstraints(), insideArea(), insideCourtyard(), isDiffPair(), BOARD_ITEM::layerMaskDescribe(), layerMaskDescribe(), CONVERT_TOOL::makePolysFromCircles(), PAD::MergePrimitivesAsPolygon(), EAGLE_PLUGIN::packageWire(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_FOOTPRINT_FP_EDITOR::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), ZONE::TransformSmoothedOutlineToPolygon(), ZONE::TransformSolidAreasShapesToPolygon(), TRACK::ViewBBox(), FOOTPRINT::ViewBBox(), ViewGetLOD(), and PAD::ViewGetLOD().

◆ GetBoundingBox()

const EDA_RECT TRACK::GetBoundingBox ( ) const
overridevirtualinherited

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 220 of file track.cpp.

221 {
222  // end of track is round, this is its radius, rounded up
223  int radius = ( m_Width + 1 ) / 2;
224  int ymax, xmax, ymin, xmin;
225 
226  if( Type() == PCB_VIA_T )
227  {
228  ymax = m_Start.y;
229  xmax = m_Start.x;
230 
231  ymin = m_Start.y;
232  xmin = m_Start.x;
233  }
234  else if( Type() == PCB_ARC_T )
235  {
236  std::shared_ptr<SHAPE> arc = GetEffectiveShape();
237  auto bbox = arc->BBox();
238 
239  xmin = bbox.GetLeft();
240  xmax = bbox.GetRight();
241  ymin = bbox.GetTop();
242  ymax = bbox.GetBottom();
243  }
244  else
245  {
246  ymax = std::max( m_Start.y, m_End.y );
247  xmax = std::max( m_Start.x, m_End.x );
248 
249  ymin = std::min( m_Start.y, m_End.y );
250  xmin = std::min( m_Start.x, m_End.x );
251  }
252 
253  ymax += radius;
254  xmax += radius;
255 
256  ymin -= radius;
257  xmin -= radius;
258 
259  // return a rectangle which is [pos,dim) in nature. therefore the +1
260  EDA_RECT ret( wxPoint( xmin, ymin ), wxSize( xmax - xmin + 1, ymax - ymin + 1 ) );
261 
262  return ret;
263 }
wxPoint m_Start
Line start point.
Definition: track.h:256
class ARC, an arc track segment on a copper layer
Definition: typeinfo.h:97
int m_Width
Thickness of track, or via diameter.
Definition: track.h:255
wxPoint m_End
Line end point.
Definition: track.h:257
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition: track.cpp:977
Handle the component boundary box.
Definition: eda_rect.h:42
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162

References TRACK::GetEffectiveShape(), TRACK::m_End, TRACK::m_Start, TRACK::m_Width, PCB_ARC_T, PCB_VIA_T, and EDA_ITEM::Type().

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), DRAWING_TOOL::DrawVia(), and TRACK::ViewBBox().

◆ GetCenter()

virtual wxPoint BOARD_ITEM::GetCenter ( ) const
inlinevirtualinherited

This defaults to the center of the bounding box if not overridden.

Returns
center point of the item

Reimplemented in ARC, PAD, PCB_SHAPE, and PCB_MARKER.

Definition at line 114 of file board_item.h.

115  {
116  return GetBoundingBox().GetCenter();
117  }
virtual const EDA_RECT GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:89
const wxPoint GetCenter() const
Definition: eda_rect.h:109

References EDA_ITEM::GetBoundingBox(), and EDA_RECT::GetCenter().

Referenced by PCB_GRID_HELPER::computeAnchors(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), and getDrilledHoleShape().

◆ GetClass()

wxString VIA::GetClass ( ) const
inlineoverridevirtual

Return the class name.

Reimplemented from TRACK.

Definition at line 419 of file track.h.

420  {
421  return wxT( "VIA" );
422  }

◆ GetDrill()

int VIA::GetDrill ( ) const
inline

Function GetDrill returns the local drill setting for this VIA.

If you want the calculated value, use GetDrillValue() instead.

Definition at line 481 of file track.h.

481 { return m_drill; }
int m_drill
for vias: via drill (- 1 for default value)
Definition: track.h:525

References m_drill.

Referenced by DRAWING_TOOL::DrawVia(), PCB_IO::format(), EAGLE_PLUGIN::loadSignals(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PNS_KICAD_IFACE_BASE::syncVia(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem().

◆ GetDrillValue()

int VIA::GetDrillValue ( ) const

Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value for the board.

Returns
real drill_value

Definition at line 173 of file track.cpp.

174 {
175  if( m_drill > 0 ) // Use the specific value.
176  return m_drill;
177 
178  // Use the default value from the Netclass
179  NETCLASS* netclass = GetNetClass();
180 
181  if( GetViaType() == VIATYPE::MICROVIA )
182  return netclass->GetuViaDrill();
183 
184  return netclass->GetViaDrill();
185 }
int m_drill
for vias: via drill (- 1 for default value)
Definition: track.h:525
virtual NETCLASS * GetNetClass() const
Return the NETCLASS for this item.
A collection of nets and the parameters used to route or test these nets.
Definition: netclass.h:46
int GetViaDrill() const
Definition: netclass.h:136
VIATYPE GetViaType() const
Definition: track.h:373
int GetuViaDrill() const
Definition: netclass.h:144

References BOARD_CONNECTED_ITEM::GetNetClass(), NETCLASS::GetuViaDrill(), NETCLASS::GetViaDrill(), GetViaType(), m_drill, and MICROVIA.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), build_via_testpoints(), ZONE_FILLER::buildCopperItemClearances(), DRC_TEST_PROVIDER_HOLE_SIZE::checkVia(), BOARD_ADAPTER::createLayers(), CreatePadsShapesSection(), CreateRoutesSection(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), export_vrml_via(), PCB_IO::format(), RENDER_3D_LEGACY::generateViasAndPads(), getDrilledHoleShape(), KIGFX::PCB_PAINTER::getDrillSize(), GetMsgPanelInfo(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), RENDER_3D_RAYTRACE::insertHole(), insideArea(), BRDITEMS_PLOTTER::PlotDrillMarks(), PlotLayerOutlines(), DRC_TEST_PROVIDER_ANNULUS::Run(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PNS_KICAD_IFACE_BASE::syncVia(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ViaSort().

◆ GetEditFlags()

STATUS_FLAGS EDA_ITEM::GetEditFlags ( ) const
inlineinherited

Definition at line 207 of file eda_item.h.

208  {
209  constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVED | IS_RESIZED | IS_DRAGGED |
211 
212  return m_flags & mask;
213  }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:107
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:115
#define IS_MOVED
Item being moved.
Definition: eda_item.h:105
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:108
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
Definition: eda_item.h:119
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110
STATUS_FLAGS m_flags
Definition: eda_item.h:530
#define IS_NEW
New item, just created.
Definition: eda_item.h:106

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

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

◆ GetEffectiveNetclass()

NETCLASS * BOARD_CONNECTED_ITEM::GetEffectiveNetclass ( ) const
virtualinherited

Return the NETCLASS for this item, or the default netclass if none is defined.

Note
Do not return a std::shared_ptr from this. It is used heavily in DRC, and the std::shared_ptr stuff shows up large in performance profiling.

Definition at line 69 of file board_connected_item.cpp.

70 {
71  // NB: we must check the net first, as when it is 0 GetNetClass() will return the
72  // orphaned net netclass, not the default netclass.
73  if( !m_netinfo || m_netinfo->GetNetCode() == 0 )
75  else
76  return GetNetClass();
77 }
virtual NETCLASS * GetNetClass() const
Return the NETCLASS for this item.
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:591
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.
NETCLASS * GetDefault() const
int GetNetCode() const
Definition: netinfo.h:113

References BOARD_ITEM::GetBoard(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), BOARD_CONNECTED_ITEM::GetNetClass(), NETINFO_ITEM::GetNetCode(), and BOARD_CONNECTED_ITEM::m_netinfo.

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > VIA::GetEffectiveShape ( PCB_LAYER_ID  aLayer = UNDEFINED_LAYER) const
overridevirtual

Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.

This routine returns a COMPOUND shape (set of simple shapes which make up the pad for use with routing, collision determination, etc).

Note
This list can contain a SHAPE_SIMPLE (a simple single-outline non-intersecting polygon), but should never contain a SHAPE_POLY_SET (a complex polygon consisting of multiple outlines and/or holes).
Parameters
aLayerin case of items spanning multiple layers, only the shapes belonging to aLayer will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.

Reimplemented from TRACK.

Definition at line 983 of file track.cpp.

984 {
985  if( FlashLayer( aLayer ) )
986  return std::make_shared<SHAPE_CIRCLE>( m_Start, m_Width / 2 );
987  else
988  return std::make_shared<SHAPE_CIRCLE>( m_Start, GetDrillValue() / 2 );
989 }
wxPoint m_Start
Line start point.
Definition: track.h:256
int m_Width
Thickness of track, or via diameter.
Definition: track.h:255
int GetDrillValue() const
Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value ...
Definition: track.cpp:173
bool FlashLayer(int aLayer) const
Checks to see whether the via should have a pad on the specific layer.
Definition: track.cpp:494

References TRACK::m_Start, and TRACK::m_Width.

◆ GetEnd()

◆ GetEndPoint()

const wxPoint& TRACK::GetEndPoint ( ENDPOINT_T  aEndPoint) const
inlineinherited

Return the selected endpoint (start or end)

Definition at line 125 of file track.h.

126  {
127  if( aEndPoint == ENDPOINT_START )
128  return m_Start;
129  else
130  return m_End;
131  }
wxPoint m_Start
Line start point.
Definition: track.h:256
wxPoint m_End
Line end point.
Definition: track.h:257

References ENDPOINT_START, TRACK::m_End, and TRACK::m_Start.

Referenced by BOARD::GetPad().

◆ GetEndX()

int TRACK::GetEndX ( ) const
inlineinherited

Definition at line 121 of file track.h.

121 { return m_End.x; }
wxPoint m_End
Line end point.
Definition: track.h:257

References TRACK::m_End.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetEndY()

int TRACK::GetEndY ( ) const
inlineinherited

Definition at line 122 of file track.h.

122 { return m_End.y; }
wxPoint m_End
Line end point.
Definition: track.h:257

References TRACK::m_End.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetFlags()

◆ GetFocusPosition()

const wxPoint TRACK::GetFocusPosition ( ) const
inlineoverridevirtualinherited

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

Reimplemented from EDA_ITEM.

Definition at line 107 of file track.h.

107 { return ( m_Start + m_End ) / 2; }
wxPoint m_Start
Line start point.
Definition: track.h:256
wxPoint m_End
Line end point.
Definition: track.h:257

References TRACK::m_End, and TRACK::m_Start.

◆ GetIsFree()

bool VIA::GetIsFree ( ) const
inline

Checks if the via is a free via (as opposed to one created on a track by the router).

Free vias don't have their nets automatically updated by the connectivity algorithm.

Returns
true if the via is a free via

Definition at line 502 of file track.h.

502 { return m_isFree; }
bool m_isFree
"Free" vias don't get their nets auto-updated
Definition: track.h:529

References m_isFree.

Referenced by CN_LIST::Add(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_IO::format(), and PNS_KICAD_IFACE_BASE::syncVia().

◆ GetKeepTopBottom()

bool VIA::GetKeepTopBottom ( ) const
inline

Definition at line 453 of file track.h.

453 { return m_keepTopBottomLayer; }
bool m_keepTopBottomLayer
Keep the top and bottom annular rings.
Definition: track.h:528

References m_keepTopBottomLayer.

Referenced by PCB_IO::format().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const
inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in ZONE.

Definition at line 173 of file board_item.h.

173 { return m_layer; }
PCB_LAYER_ID m_layer
Definition: board_item.h:363

References BOARD_ITEM::m_layer.

Referenced by CN_LIST::Add(), BOARD_ADAPTER::addFootprintShapesWithClearance(), GRAPHICS_CLEANER::areEquivalent(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), AR_AUTOPLACER::buildFpAreas(), TRACKS_CLEANER::cleanup(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), CreateRoutesSection(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), export_vrml_drawsegment(), export_vrml_footprint(), export_vrml_fp_shape(), export_vrml_fp_text(), export_vrml_pcbtext(), export_vrml_tracks(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), TRACK::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), DIMENSION_BASE::Flip(), FOOTPRINT::Flip(), ARC::Flip(), PCB_SHAPE::Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_IO::FootprintSave(), FootprintWriteShape(), PCB_IO::format(), PCB_IO::formatLayer(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromBOARD(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), FOOTPRINT::GetBoundingBox(), ZONE::GetLayer(), getMatchingTextItem(), TRACK::GetMsgPanelInfo(), GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalFPPlacement(), BOARD::GetPad(), FP_TEXT_GRID_TABLE::GetValueAsLong(), TRACK::GetWidthConstraints(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), idf_export_footprint(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), isEdge(), PAD::IsFlipped(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_ITEM::IsOnCopperLayer(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), TRACK::cmp_tracks::operator()(), BOARD_ITEM::ptr_cmp::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), EAGLE_PLUGIN::packagePad(), BRDITEMS_PLOTTER::PlotBoardGraphicItems(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), BRDITEMS_PLOTTER::PlotPcbText(), CONVERT_TOOL::PolyToLines(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PAD_TOOL::recombinePad(), CLIPBOARD_IO::SaveSelection(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::Selectable(), FP_TEXT_GRID_TABLE::SetValueAsLong(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTrack(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), AR_AUTOPLACER::testFootprintOnBoard(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolygon(), FOOTPRINT::TransformFPShapesWithClearanceToPolygon(), TRACK::ViewGetLayers(), FP_TEXT::ViewGetLayers(), FP_TEXT::ViewGetLOD(), FP_ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const
inherited

Return the name of the PCB layer on which the item resides.

Returns
the layer name associated with this item.

Definition at line 60 of file board_item.cpp.

61 {
62  BOARD* board = GetBoard();
63 
64  if( board )
65  return board->GetLayerName( m_layer );
66 
67  // If no parent, return standard name
69 }
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:342
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
PCB_LAYER_ID m_layer
Definition: board_item.h:363
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:674

References BOARD_ITEM::GetBoard(), BOARD::GetLayerName(), BOARD::GetStandardLayerName(), and BOARD_ITEM::m_layer.

Referenced by PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), LEADER::GetMsgPanelInfo(), PCB_TEXT::GetSelectMenuText(), FP_SHAPE::GetSelectMenuText(), TRACK::GetSelectMenuText(), DIMENSION_BASE::GetSelectMenuText(), PCB_SHAPE::GetSelectMenuText(), PCB_TEXT::GetShownText(), FP_TEXT_GRID_TABLE::GetValue(), and FOOTPRINT::ResolveTextVar().

◆ GetLayerSet()

LSET VIA::GetLayerSet ( ) const
overridevirtual

Return a std::bitset of all layers on which the item physically resides.

Reimplemented from BOARD_ITEM.

Definition at line 376 of file track.cpp.

377 {
378  if( GetViaType() == VIATYPE::THROUGH )
379  return LSET::AllCuMask();
380 
381  // VIA_BLIND_BURIED or VIA_MICRVIA:
382 
383  LSET layermask;
384 
385  wxASSERT( m_layer <= m_bottomLayer );
386 
387  // PCB_LAYER_IDs are numbered from front to back, this is top to bottom.
388  for( LAYER_NUM id = m_layer; id <= m_bottomLayer; ++id )
389  {
390  layermask.set( id );
391  }
392 
393  return layermask;
394 }
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
LSET is a set of PCB_LAYER_IDs.
int LAYER_NUM
This can be replaced with int and removed.
VIATYPE GetViaType() const
Definition: track.h:373
PCB_LAYER_ID m_layer
Definition: board_item.h:363
PCB_LAYER_ID m_bottomLayer
The bottom layer of the via (the top layer is in m_layer)
Definition: track.h:521

References LSET::AllCuMask(), GetViaType(), m_bottomLayer, BOARD_ITEM::m_layer, and THROUGH.

Referenced by TRACKS_CLEANER::cleanup(), CreatePadsShapesSection(), CreateRoutesSection(), DRAWING_TOOL::DrawVia(), PlotSolderMaskLayer(), PlotStandardLayer(), PCB_SELECTION_TOOL::Selectable(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), and ViaSort().

◆ GetLength()

virtual double TRACK::GetLength ( ) const
inlinevirtualinherited

Function GetLength returns the length of the track using the hypotenuse calculation.

Returns
double - the length of the track

Reimplemented in ARC.

Definition at line 141 of file track.h.

142  {
143  return GetLineLength( m_Start, m_End );
144  }
wxPoint m_Start
Line start point.
Definition: track.h:256
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Return the length of a line segment defined by aPointA and aPointB.
Definition: trigo.h:223
wxPoint m_End
Line end point.
Definition: track.h:257

References GetLineLength(), TRACK::m_End, and TRACK::m_Start.

Referenced by EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), and TRACK::GetSelectMenuText().

◆ GetLocalClearance()

int TRACK::GetLocalClearance ( wxString *  aSource) const
overridevirtualinherited

Function GetLocalClearance returns any local clearance overrides set in the "classic" (ie: pre-rule) system.

Parameters
aSource[out] optionally reports the source as a user-readable string
Returns
int - the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 107 of file track.cpp.

108 {
109  // Not currently implemented
110  return 0;
111 }

◆ GetLocalClearanceOverrides()

virtual int BOARD_CONNECTED_ITEM::GetLocalClearanceOverrides ( wxString *  aSource) const
inlinevirtualinherited

Return any local clearance overrides set in the "classic" (ie: pre-rule) system.

Parameters
aSource[out] optionally reports the source as a user-readable string.
Returns
the clearance in internal units.

Reimplemented in PAD.

Definition at line 153 of file board_connected_item.h.

153 { return 0; }

Referenced by DRC_ENGINE::EvalRules().

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const
inlineinherited

◆ GetMenuImage()

BITMAP_DEF VIA::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 TRACK.

Definition at line 101 of file track.cpp.

102 {
103  return via_xpm;
104 }
const BITMAP_OPAQUE via_xpm[1]

References via_xpm.

◆ GetMinAnnulus()

int VIA::GetMinAnnulus ( PCB_LAYER_ID  aLayer,
wxString *  aSource 
) const

Definition at line 142 of file track.cpp.

143 {
144  if( !FlashLayer( aLayer ) )
145  {
146  if( aSource )
147  *aSource = _( "removed annular ring" );
148 
149  return 0;
150  }
151 
152  DRC_CONSTRAINT constraint;
153 
154  if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
155  {
157 
158  constraint = bds.m_DRCEngine->EvalRules( ANNULAR_WIDTH_CONSTRAINT, this, nullptr, aLayer );
159  }
160 
161  if( constraint.Value().HasMin() )
162  {
163  if( aSource )
164  *aSource = constraint.GetName();
165 
166  return constraint.Value().Min();
167  }
168 
169  return 0;
170 }
bool HasMin() const
Definition: minoptmax.h:37
MINOPTMAX< int > & Value()
Definition: drc_rule.h:122
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:591
T Min() const
Definition: minoptmax.h:33
wxString GetName() const
Definition: drc_rule.h:127
bool FlashLayer(int aLayer) const
Checks to see whether the via should have a pad on the specific layer.
Definition: track.cpp:494
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
#define _(s)
Definition: 3d_actions.cpp:33
std::shared_ptr< DRC_ENGINE > m_DRCEngine
Container for design settings for a BOARD object.

References _, ANNULAR_WIDTH_CONSTRAINT, FlashLayer(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), DRC_CONSTRAINT::GetName(), MINOPTMAX< T >::HasMin(), BOARD_DESIGN_SETTINGS::m_DRCEngine, MINOPTMAX< T >::Min(), and DRC_CONSTRAINT::Value().

Referenced by GetMsgPanelInfo().

◆ GetMsgPanelInfo()

void VIA::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
aListis the list to populate.

Reimplemented from TRACK.

Definition at line 694 of file track.cpp.

695 {
696  EDA_UNITS units = aFrame->GetUserUnits();
697  wxString msg;
698 
699  switch( GetViaType() )
700  {
701  case VIATYPE::MICROVIA: msg = _( "Micro Via" ); break;
702  case VIATYPE::BLIND_BURIED: msg = _( "Blind/Buried Via" ); break;
703  case VIATYPE::THROUGH: msg = _( "Through Via" ); break;
704  default: msg = _( "Via" ); break;
705  }
706 
707  aList.emplace_back( _( "Type" ), msg );
708 
709  GetMsgPanelInfoBase_Common( aFrame, aList );
710 
711  aList.emplace_back( _( "Layer" ), layerMaskDescribe() );
712 
713  msg = MessageTextFromValue( aFrame->GetUserUnits(), m_Width );
714 
715  aList.emplace_back( _( "Diameter" ), msg );
716 
717  msg = MessageTextFromValue( aFrame->GetUserUnits(), GetDrillValue() );
718 
719  aList.emplace_back( _( "Drill" ), msg );
720 
721  wxString source;
722  int clearance = GetOwnClearance( GetLayer(), &source );
723 
724  aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ),
725  MessageTextFromValue( units, clearance ) ),
726  wxString::Format( _( "(from %s)" ), source ) );
727 
728  int minAnnulus = GetMinAnnulus( GetLayer(), &source );
729 
730  aList.emplace_back( wxString::Format( _( "Min Annular Width: %s" ),
731  MessageTextFromValue( units, minAnnulus ) ),
732  wxString::Format( _( "(from %s)" ), source ) );
733 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:125
void GetMsgPanelInfoBase_Common(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) const
Definition: track.cpp:736
int m_Width
Thickness of track, or via diameter.
Definition: track.h:255
int GetMinAnnulus(PCB_LAYER_ID aLayer, wxString *aSource) const
Definition: track.cpp:142
int GetDrillValue() const
Function GetDrillValue "calculates" the drill value for vias (m-Drill if > 0, or default drill value ...
Definition: track.cpp:173
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
EDA_UNITS
Definition: eda_units.h:38
wxString layerMaskDescribe() const override
Return a string (to be shown to the user) describing a layer mask.
Definition: track.cpp:768
#define _(s)
Definition: 3d_actions.cpp:33
VIATYPE GetViaType() const
Definition: track.h:373
virtual int GetOwnClearance(PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
Return an item's "own" clearance in internal units.
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:173
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References _, BLIND_BURIED, Format(), GetDrillValue(), BOARD_ITEM::GetLayer(), GetMinAnnulus(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetOwnClearance(), EDA_BASE_FRAME::GetUserUnits(), GetViaType(), layerMaskDescribe(), TRACK::m_Width, MessageTextFromValue(), MICROVIA, and THROUGH.

◆ GetMsgPanelInfoBase_Common()

void TRACK::GetMsgPanelInfoBase_Common ( EDA_DRAW_FRAME aFrame,
std::vector< MSG_PANEL_ITEM > &  aList 
) const
protectedinherited

Definition at line 736 of file track.cpp.

737 {
738  wxString msg;
739 
740  aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );
741 
742  aList.emplace_back( _( "NetClass" ), UnescapeString( GetNetClass()->GetName() ) );
743 
744  #if 0 // Enable for debugging
745  if( GetBoard() )
746  {
747  // Display net code:
748  msg.Printf( wxT( "%d" ), GetNetCode() );
749  aList.emplace_back( _( "NetCode" ), msg );
750  }
751 
752  // Display the flags:
753  msg.Printf( wxT( "0x%08X" ), m_flags );
754  aList.emplace_back( wxT( "Flags" ), msg );
755 
756  // Display start and end positions:
757  msg.Printf( wxT( "%d %d" ), m_Start.x, m_Start.y );
758  aList.push_back( MSG_PANEL_ITEM( wxT( "Start pos" ), msg ) );
759  msg.Printf( wxT( "%d %d" ), m_End.x, m_End.y );
760  aList.push_back( MSG_PANEL_ITEM( wxT( "End pos" ), msg ) );
761 #endif
762 
763  // Display the State member
764  aList.emplace_back( _( "Status" ), IsLocked() ? _( "Locked" ) : wxT( "" ) );
765 }
wxPoint m_Start
Line start point.
Definition: track.h:256
virtual NETCLASS * GetNetClass() const
Return the NETCLASS for this item.
wxString GetNetname() const
wxPoint m_End
Line end point.
Definition: track.h:257
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
virtual bool IsLocked() const
Definition: board_item.h:249
#define _(s)
Definition: 3d_actions.cpp:33
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:150
EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:54
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References _, BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::GetNetClass(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), BOARD_ITEM::IsLocked(), TRACK::m_End, EDA_ITEM::m_flags, TRACK::m_Start, and UnescapeString().

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

◆ GetNet()

NETINFO_ITEM* BOARD_CONNECTED_ITEM::GetNet ( ) const
inlineinherited

◆ GetNetClass()

NETCLASS * BOARD_CONNECTED_ITEM::GetNetClass ( ) const
virtualinherited

Return the NETCLASS for this item.

Note
Do not return a std::shared_ptr from this. It is used heavily in DRC, and the std::shared_ptr stuff shows up large in performance profiling.

Reimplemented in ZONE.

Definition at line 108 of file board_connected_item.cpp.

109 {
110  if( m_netinfo && m_netinfo->GetNetClass() )
111  return m_netinfo->GetNetClass();
112  else
113  return GetBoard()->GetDesignSettings().GetDefault();
114 }
NETCLASS * GetNetClass()
Definition: netinfo.h:103
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:591
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.
NETCLASS * GetDefault() const

References BOARD_ITEM::GetBoard(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), NETINFO_ITEM::GetNetClass(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by EDIT_TOOL::ChangeTrackWidth(), DRAWING_TOOL::DrawVia(), GetDrillValue(), BOARD_CONNECTED_ITEM::GetEffectiveNetclass(), BOARD_INSPECTION_TOOL::getItemDescription(), PAD::GetMsgPanelInfo(), TRACK::GetMsgPanelInfoBase_Common(), ZONE::GetNetClass(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), and DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ GetNetClassName()

wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const
virtualinherited

Returns the netclass of the zone.

If the net is not found (can happen when a netlist is reread) and the net name does not exist, return the default net class (should not return a null pointer).

Returns
the net class name of this item.

Reimplemented in ZONE.

Definition at line 117 of file board_connected_item.cpp.

118 {
119  if( m_netinfo )
120  return m_netinfo->GetNetClassName();
121  else
122  return wxEmptyString;
123 }
wxString GetNetClassName() const
Definition: netinfo.h:108
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.

References NETINFO_ITEM::GetNetClassName(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), ZONE::GetNetClassName(), main(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const
inlineinherited
Returns
the net code.

Definition at line 93 of file board_connected_item.h.

94  {
95  return m_netinfo ? m_netinfo->GetNetCode() : -1;
96  }
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.
int GetNetCode() const
Definition: netinfo.h:113

References NETINFO_ITEM::GetNetCode(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), ZONE_FILLER::buildCopperItemClearances(), connectedItemFilter(), CreateRoutesSection(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), ZONE_FILLER::Fill(), PNS::NODE::FindItemByParent(), PCB_IO::format(), DSN::SPECCTRA_DB::FromBOARD(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), CONNECTIVITY_DATA::GetConnectedItems(), ZONE::GetInteractingZones(), TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), hash_fp_item(), hasThermalConnection(), BOARD_INSPECTION_TOOL::highlightNet(), DIALOG_PAD_PROPERTIES::initValues(), BOARD_INSPECTION_TOOL::InspectClearance(), CONNECTIVITY_DATA::IsConnectedOnLayer(), ZONE::IsIsland(), ZONE::IsSame(), ZONE_FILLER::knockoutThermalReliefs(), DSN::SPECCTRA_DB::makeIMAGE(), AR_AUTOPLACER::nearestPad(), ROUTER_TOOL::NeighboringSegmentFilter(), CN_ITEM::Net(), BOARD::NormalizeAreaPolygon(), TRACK::cmp_tracks::operator()(), ZONE_SETTINGS::operator<<(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), process(), BOARD_EDITOR_CONTROL::RepairBoard(), PCB_SELECTION_CONDITIONS::sameNetFunc(), SaveCopyOfZones(), PCB_SELECTION_TOOL::selectNet(), ZONE_FILLER::subtractHigherPriorityZones(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZones(), BOARD::TracksInNet(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetNetname()

◆ GetNetnameMsg()

wxString BOARD_CONNECTED_ITEM::GetNetnameMsg ( ) const
inherited
Returns
the full netname or "<no net>" in square braces, followed by "(Not Found)" if the netcode is undefined.

Definition at line 126 of file board_connected_item.cpp.

127 {
128  if( !GetBoard() )
129  return wxT( "[** NO BOARD DEFINED **]" );
130 
131  wxString netname = GetNetname();
132 
133  if( !netname.length() )
134  return wxT( "[<no net>]" );
135  else if( GetNetCode() < 0 )
136  return wxT( "[" + UnescapeString( netname ) + "](" + _( "Not Found" ) + ")" );
137  else
138  return wxT( "[" + UnescapeString( netname ) + "]" );
139 }
wxString GetNetname() const
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
#define _(s)
Definition: 3d_actions.cpp:33
wxString UnescapeString(const wxString &aSource)
Definition: string.cpp:150

References _, BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), and UnescapeString().

Referenced by TRACK::GetSelectMenuText(), GetSelectMenuText(), and ZONE::GetSelectMenuText().

◆ GetOwnClearance()

int BOARD_CONNECTED_ITEM::GetOwnClearance ( PCB_LAYER_ID  aLayer,
wxString *  aSource = nullptr 
) const
virtualinherited

Return an item's "own" clearance in internal units.

Parameters
aLayerthe layer in question.
aSource[out] optionally reports the source as a user-readable string.
Returns
the clearance in internal units.

Definition at line 83 of file board_connected_item.cpp.

84 {
85  DRC_CONSTRAINT constraint;
86 
87  if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
88  {
90 
91  constraint = bds.m_DRCEngine->EvalRules( CLEARANCE_CONSTRAINT, this, nullptr, aLayer );
92  }
93 
94  if( constraint.Value().HasMin() )
95  {
96  if( aSource )
97  *aSource = constraint.GetName();
98 
99  return constraint.Value().Min();
100  }
101 
102  return 0;
103 }
bool HasMin() const
Definition: minoptmax.h:37
MINOPTMAX< int > & Value()
Definition: drc_rule.h:122
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:591
T Min() const
Definition: minoptmax.h:33
wxString GetName() const
Definition: drc_rule.h:127
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
std::shared_ptr< DRC_ENGINE > m_DRCEngine
Container for design settings for a BOARD object.

References CLEARANCE_CONSTRAINT, BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), DRC_CONSTRAINT::GetName(), MINOPTMAX< T >::HasMin(), BOARD_DESIGN_SETTINGS::m_DRCEngine, MINOPTMAX< T >::Min(), and DRC_CONSTRAINT::Value().

Referenced by KIGFX::PCB_PAINTER::draw(), ZONE::GetMsgPanelInfo(), TRACK::GetMsgPanelInfo(), GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), and PAD::ViewBBox().

◆ GetParent()

BOARD_ITEM_CONTAINER* BOARD_ITEM::GetParent ( void  ) const
inlineinherited

Definition at line 168 of file board_item.h.

168 { return (BOARD_ITEM_CONTAINER*) m_parent; }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:528
Abstract interface for BOARD_ITEMs capable of storing other items inside.

References EDA_ITEM::m_parent.

Referenced by PCB_POINT_EDITOR::addCorner(), ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PNS_KICAD_IFACE::Commit(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), EDIT_TOOL::CreateArray(), BOARD_ITEM::DeleteStructure(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeCentersVertically(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::FilterCollectorForGroups(), EDIT_TOOL::Flip(), PCB_IO::format(), FormatProbeItem(), BOARD_ITEM::GetBoard(), PCB_MARKER::GetColorLayer(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), FP_TEXT::GetSelectMenuText(), PCB_TEXT::GetShownText(), FP_TEXT::GetShownText(), insideArea(), GENERAL_COLLECTOR::Inspect(), ARRAY_CREATOR::Invoke(), DRC_ENGINE::IsNetTie(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), LEGACY_PLUGIN::loadMODULE_TEXT(), memberOf(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), ALTIUM_PCB::ParseTexts6Data(), BRDITEMS_PLOTTER::PlotFootprintGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), POSITION_RELATIVE_TOOL::PositionRelative(), BOARD_COMMIT::Push(), PCB_PARSER::resolveGroups(), EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::Selectable(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), PCB_GROUP::TopLevelGroup(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_MARKER::ViewGetLayers(), FP_ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and PCB_GROUP::WithinScope().

◆ GetParentGroup()

◆ GetPosition()

◆ GetRemoveUnconnected()

bool VIA::GetRemoveUnconnected ( ) const
inline

Definition at line 447 of file track.h.

447 { return m_removeUnconnectedLayer; }
bool m_removeUnconnectedLayer
Remove unconnected copper on a via.
Definition: track.h:527

References m_removeUnconnectedLayer.

Referenced by PCB_IO::format().

◆ GetSelectMenuText()

wxString VIA::GetSelectMenuText ( EDA_UNITS  aUnits) const
overridevirtual

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

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

Returns
The menu text string.

Reimplemented from TRACK.

Definition at line 84 of file track.cpp.

85 {
86  wxString formatStr;
87 
88  switch( GetViaType() )
89  {
90  case VIATYPE::BLIND_BURIED: formatStr = _( "Blind/Buried Via %s on %s" ); break;
91  case VIATYPE::MICROVIA: formatStr = _( "Micro Via %s on %s" ); break;
92  default: formatStr = _( "Via %s on %s" ); break;
93  }
94 
95  return wxString::Format( formatStr,
96  GetNetnameMsg(),
98 }
wxString GetNetnameMsg() const
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
wxString layerMaskDescribe() const override
Return a string (to be shown to the user) describing a layer mask.
Definition: track.cpp:768
#define _(s)
Definition: 3d_actions.cpp:33
VIATYPE GetViaType() const
Definition: track.h:373

References _, BLIND_BURIED, Format(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), GetViaType(), layerMaskDescribe(), and MICROVIA.

Referenced by PCB_IO::format().

◆ GetShortNetname()

wxString BOARD_CONNECTED_ITEM::GetShortNetname ( ) const
inlineinherited
Returns
the short netname.

Definition at line 133 of file board_connected_item.h.

134  {
135  return m_netinfo->GetShortNetname();
136  }
const wxString & GetShortNetname() const
Definition: netinfo.h:124
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.

References NETINFO_ITEM::GetShortNetname(), and BOARD_CONNECTED_ITEM::m_netinfo.

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

◆ GetStart()

◆ GetState()

int EDA_ITEM::GetState ( int  type) const
inlineinherited

Definition at line 186 of file eda_item.h.

187  {
188  return m_status & type;
189  }
STATUS_FLAGS m_status
Definition: eda_item.h:527

References EDA_ITEM::m_status.

Referenced by BOARD_ITEM::IsLocked().

◆ GetStatus()

STATUS_FLAGS EDA_ITEM::GetStatus ( ) const
inlineinherited

Definition at line 199 of file eda_item.h.

199 { return m_status; }
STATUS_FLAGS m_status
Definition: eda_item.h:527

References EDA_ITEM::m_status.

◆ GetViaType()

◆ GetWidth()

◆ GetWidthConstraints()

void TRACK::GetWidthConstraints ( int *  aMin,
int *  aMax,
wxString *  aSource 
) const
inherited

Definition at line 114 of file track.cpp.

115 {
116  *aMin = 0;
117  *aMax = INT_MAX;
118 
119  DRC_CONSTRAINT constraint;
120 
121  if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
122  {
124 
125  constraint = bds.m_DRCEngine->EvalRules( TRACK_WIDTH_CONSTRAINT, this, nullptr, GetLayer() );
126  }
127 
128  if( constraint.Value().HasMin() || constraint.Value().HasMax() )
129  {
130  if( constraint.Value().HasMin() )
131  *aMin = constraint.Value().Min();
132 
133  if( constraint.Value().HasMax() )
134  *aMax = constraint.Value().Max();
135 
136  if( aSource )
137  *aSource = constraint.GetName();
138  }
139 }
bool HasMin() const
Definition: minoptmax.h:37
MINOPTMAX< int > & Value()
Definition: drc_rule.h:122
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:591
T Min() const
Definition: minoptmax.h:33
T Max() const
Definition: minoptmax.h:34
wxString GetName() const
Definition: drc_rule.h:127
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
bool HasMax() const
Definition: minoptmax.h:38
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:173
std::shared_ptr< DRC_ENGINE > m_DRCEngine
Container for design settings for a BOARD object.

References BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), BOARD_ITEM::GetLayer(), DRC_CONSTRAINT::GetName(), MINOPTMAX< T >::HasMax(), MINOPTMAX< T >::HasMin(), BOARD_DESIGN_SETTINGS::m_DRCEngine, MINOPTMAX< T >::Max(), MINOPTMAX< T >::Min(), TRACK_WIDTH_CONSTRAINT, and DRC_CONSTRAINT::Value().

Referenced by TRACK::GetMsgPanelInfo().

◆ GetX()

int BOARD_ITEM::GetX ( ) const
inlineinherited

◆ GetY()

int BOARD_ITEM::GetY ( ) const
inlineinherited

◆ HasFlag()

◆ HitTest() [1/2]

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

Test if aPosition is contained within or on the bounding box of an item.

Parameters
aPositionA reference to a wxPoint 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 TRACK.

Definition at line 822 of file track.cpp.

823 {
824  int max_dist = aAccuracy + ( m_Width / 2 );
825 
826  // rel_pos is aPosition relative to m_Start (or the center of the via)
827  wxPoint rel_pos = aPosition - m_Start;
828  double dist = (double) rel_pos.x * rel_pos.x + (double) rel_pos.y * rel_pos.y;
829  return dist <= (double) max_dist * max_dist;
830 }
wxPoint m_Start
Line start point.
Definition: track.h:256
int m_Width
Thickness of track, or via diameter.
Definition: track.h:255

References TRACK::m_Start, and TRACK::m_Width.

◆ HitTest() [2/2]

bool VIA::HitTest ( const EDA_RECT aRect,
bool  aContained,
int  aAccuracy = 0 
) const
overridevirtual

Test if aRect intersects or is contained within the bounding box of an item.

Parameters
aRectA reference to a EDA_RECT 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 TRACK.

Definition at line 864 of file track.cpp.

865 {
866  EDA_RECT box;
867  EDA_RECT arect = aRect;
868  arect.Inflate( aAccuracy );
869 
870  box.SetOrigin( GetStart() );
871  box.Inflate( GetWidth() / 2 );
872 
873  if( aContained )
874  return arect.Contains( box );
875  else
876  return arect.IntersectsCircle( GetStart(), GetWidth() / 2 );
877 }
const wxPoint & GetStart() const
Definition: track.h:116
bool IntersectsCircle(const wxPoint &aCenter, const int aRadius) const
Test for a common area between a circle and this rectangle.
Definition: eda_rect.cpp:314
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:126
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
int GetWidth() const
Definition: track.h:110
Handle the component boundary box.
Definition: eda_rect.h:42
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363

References EDA_RECT::Contains(), TRACK::GetStart(), TRACK::GetWidth(), EDA_RECT::Inflate(), EDA_RECT::IntersectsCircle(), and EDA_RECT::SetOrigin().

◆ IsBrightened()

◆ IsConnected()

bool BOARD_CONNECTED_ITEM::IsConnected ( ) const
inlineoverridevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

Returns
True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.

Reimplemented from BOARD_ITEM.

Reimplemented in ZONE.

Definition at line 69 of file board_connected_item.h.

70  {
71  return true;
72  }

Referenced by BOARD_INSPECTION_TOOL::InspectClearance().

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const
inlineinherited

Definition at line 170 of file eda_item.h.

170 { return m_flags & IS_DRAGGED; }
#define IS_DRAGGED
Item being dragged.
Definition: eda_item.h:108
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References IS_DRAGGED, and EDA_ITEM::m_flags.

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

◆ IsDrillDefault()

bool VIA::IsDrillDefault ( ) const
inline

Function IsDrillDefault.

Returns
true if the drill value is default value (-1)

Definition at line 509 of file track.h.

509 { return m_drill <= 0; }
int m_drill
for vias: via drill (- 1 for default value)
Definition: track.h:525

References m_drill.

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const
inlineinherited

Definition at line 173 of file eda_item.h.

173 { return m_flags & ENTERED; }
#define ENTERED
indicates a group has been entered
Definition: eda_item.h:137
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const
inlineinherited

Definition at line 255 of file eda_item.h.

255 { return m_forceVisible; }
bool m_forceVisible
Definition: eda_item.h:529

References EDA_ITEM::m_forceVisible.

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

◆ IsLocked()

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const
inlineinherited

Definition at line 167 of file eda_item.h.

167 { return m_flags & IS_CHANGED; }
#define IS_CHANGED
Item was edited, and modified.
Definition: eda_item.h:102
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

◆ IsNew()

◆ IsNull()

bool TRACK::IsNull ( ) const
inlineinherited

Function IsNull returns true if segment length is zero.

Definition at line 178 of file track.h.

179  {
180  return ( Type() == PCB_VIA_T ) || ( m_Start == m_End );
181  }
wxPoint m_Start
Line start point.
Definition: track.h:256
wxPoint m_End
Line end point.
Definition: track.h:257
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162

References TRACK::m_End, TRACK::m_Start, PCB_VIA_T, and EDA_ITEM::Type().

◆ IsOnCopperLayer()

bool TRACK::IsOnCopperLayer ( ) const
inlineoverridevirtualinherited
Returns
true because a track or a via is always on a copper layer.

Reimplemented from BOARD_ITEM.

Definition at line 229 of file track.h.

230  {
231  return true;
232  }

◆ IsOnLayer()

bool VIA::IsOnLayer ( PCB_LAYER_ID  aLayer) const
overridevirtual

Test to see if this object is on the given layer.

Virtual so objects like PAD, which reside on multiple layers can do their own form of testing.

Parameters
aLayerThe layer to test for.
Returns
true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 361 of file track.cpp.

362 {
363  PCB_LAYER_ID bottom_layer, top_layer;
364 
365  LayerPair( &top_layer, &bottom_layer );
366 
367  wxASSERT( top_layer <= bottom_layer );
368 
369  if( top_layer <= layer_number && layer_number <= bottom_layer )
370  return true;
371  else
372  return false;
373 }
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between thes...
Definition: track.cpp:435
PCB_LAYER_ID
A quick note on layer IDs:

References LayerPair().

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), FlashLayer(), and PlotLayerOutlines().

◆ IsPointOnEnds()

STATUS_FLAGS TRACK::IsPointOnEnds ( const wxPoint &  point,
int  min_dist = 0 
) const
inherited

Function IsPointOnEnds returns STARTPOINT if point if near (dist = min_dist) start point, ENDPOINT if point if near (dist = min_dist) end point,STARTPOINT|ENDPOINT if point if near (dist = min_dist) both ends, or 0 if none of the above.

if min_dist < 0: min_dist = track_width/2

Definition at line 188 of file track.cpp.

189 {
190  STATUS_FLAGS result = 0;
191 
192  if( min_dist < 0 )
193  min_dist = m_Width / 2;
194 
195  if( min_dist == 0 )
196  {
197  if( m_Start == point )
198  result |= STARTPOINT;
199 
200  if( m_End == point )
201  result |= ENDPOINT;
202  }
203  else
204  {
205  double dist = GetLineLength( m_Start, point );
206 
207  if( min_dist >= KiROUND( dist ) )
208  result |= STARTPOINT;
209 
210  dist = GetLineLength( m_End, point );
211 
212  if( min_dist >= KiROUND( dist ) )
213  result |= ENDPOINT;
214  }
215 
216  return result;
217 }
wxPoint m_Start
Line start point.
Definition: track.h:256
double GetLineLength(const wxPoint &aPointA, const wxPoint &aPointB)
Return the length of a line segment defined by aPointA and aPointB.
Definition: trigo.h:223
int m_Width
Thickness of track, or via diameter.
Definition: track.h:255
wxPoint m_End
Line end point.
Definition: track.h:257
unsigned STATUS_FLAGS
Definition: eda_item.h:144
#define STARTPOINT
When a line is selected, these flags indicate which.
Definition: eda_item.h:111
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:68
#define ENDPOINT
ends. (Used to support dragging.)
Definition: eda_item.h:112

References ENDPOINT, GetLineLength(), KiROUND(), TRACK::m_End, TRACK::m_Start, TRACK::m_Width, and STARTPOINT.

Referenced by EDIT_TOOL::FilletTracks(), and ROUTER_TOOL::NeighboringSegmentFilter().

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

Definition at line 452 of file eda_item.h.

452 { return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const
inlineinherited

Definition at line 174 of file eda_item.h.

174 { return m_flags & IS_RESIZED; }
#define IS_RESIZED
Item being resized.
Definition: eda_item.h:107
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References IS_RESIZED, and EDA_ITEM::m_flags.

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

◆ IsSelected()

◆ IsTrack()

bool BOARD_ITEM::IsTrack ( ) const
inlineinherited

Test to see if this object is a track or via (or microvia).

Returns
true if a track or via, else false.

Definition at line 241 of file board_item.h.

242  {
243  return ( Type() == PCB_TRACE_T ) || ( Type() == PCB_VIA_T );
244  }
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162

References PCB_TRACE_T, PCB_VIA_T, and EDA_ITEM::Type().

◆ IsType()

bool VIA::IsType ( const KICAD_T  aScanTypes[]) const
inlineoverridevirtual

Check whether the item is one of the listed types.

Parameters
aScanTypesList of item types
Returns
true if the item type is contained in the list aScanTypes

Reimplemented from EDA_ITEM.

Definition at line 355 of file track.h.

356  {
357  if( BOARD_CONNECTED_ITEM::IsType( aScanTypes ) )
358  return true;
359 
360  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
361  {
363  return true;
364  else if( *p == PCB_LOCATE_UVIA_T && m_viaType == VIATYPE::MICROVIA )
365  return true;
366  else if( *p == PCB_LOCATE_BBVIA_T && m_viaType == VIATYPE::BLIND_BURIED )
367  return true;
368  }
369 
370  return false;
371  }
VIATYPE m_viaType
through, blind/buried or micro
Definition: track.h:523
search types array terminator (End Of Types)
Definition: typeinfo.h:81
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
virtual bool IsType(const KICAD_T aScanTypes[]) const
Check whether the item is one of the listed types.
Definition: eda_item.h:232

References BLIND_BURIED, EOT, EDA_ITEM::IsType(), m_viaType, MICROVIA, PCB_LOCATE_BBVIA_T, PCB_LOCATE_STDVIA_T, PCB_LOCATE_UVIA_T, and THROUGH.

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const
inlineinherited

Definition at line 171 of file eda_item.h.

171 { return m_flags & IS_WIRE_IMAGE; }
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

◆ IterateForward() [1/2]

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

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

Definition at line 344 of file eda_item.h.

348  {
349  for( auto it : aList )
350  {
351  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
353  return SEARCH_RESULT::QUIT;
354  }
355 
357  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:107

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

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

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

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

Definition at line 363 of file eda_item.h.

365  {
366  for( auto it : aList )
367  {
368  if( static_cast<EDA_ITEM*>( it )->Visit( inspector, testData, scanTypes )
370  return SEARCH_RESULT::QUIT;
371  }
372 
374  }
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:107

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

◆ layerMaskDescribe()

wxString VIA::layerMaskDescribe ( ) const
overrideprotectedvirtual

Return a string (to be shown to the user) describing a layer mask.

The BOARD is needed because layer names are customizable.

Reimplemented from BOARD_ITEM.

Definition at line 768 of file track.cpp.

769 {
770  BOARD* board = GetBoard();
771  PCB_LAYER_ID top_layer;
772  PCB_LAYER_ID bottom_layer;
773 
774  LayerPair( &top_layer, &bottom_layer );
775 
776  return board->GetLayerName( top_layer ) + wxT( " - " ) + board->GetLayerName( bottom_layer );
777 }
void LayerPair(PCB_LAYER_ID *top_layer, PCB_LAYER_ID *bottom_layer) const
Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between thes...
Definition: track.cpp:435
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:342
PCB_LAYER_ID
A quick note on layer IDs:
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190

References BOARD_ITEM::GetBoard(), BOARD::GetLayerName(), and LayerPair().

Referenced by GetMsgPanelInfo(), and GetSelectMenuText().

◆ LayerPair()

void VIA::LayerPair ( PCB_LAYER_ID top_layer,
PCB_LAYER_ID bottom_layer 
) const

Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between these 2 layers)

Parameters
top_layer= pointer to the first layer (can be null)
bottom_layer= pointer to the last layer (can be null)

Definition at line 435 of file track.cpp.

436 {
437  PCB_LAYER_ID t_layer = F_Cu;
438  PCB_LAYER_ID b_layer = B_Cu;
439 
440  if( GetViaType() != VIATYPE::THROUGH )
441  {
442  b_layer = m_bottomLayer;
443  t_layer = m_layer;
444 
445  if( b_layer < t_layer )
446  std::swap( b_layer, t_layer );
447  }
448 
449  if( top_layer )
450  *top_layer = t_layer;
451 
452  if( bottom_layer )
453  *bottom_layer = b_layer;
454 }
PCB_LAYER_ID
A quick note on layer IDs:
VIATYPE GetViaType() const
Definition: track.h:373
PCB_LAYER_ID m_layer
Definition: board_item.h:363
PCB_LAYER_ID m_bottomLayer
The bottom layer of the via (the top layer is in m_layer)
Definition: track.h:521

References B_Cu, F_Cu, GetViaType(), m_bottomLayer, BOARD_ITEM::m_layer, and THROUGH.

Referenced by build_via_testpoints(), KIGFX::PCB_PAINTER::draw(), export_vrml_via(), Flip(), PCB_IO::format(), RENDER_3D_LEGACY::generateViasAndPads(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), RENDER_3D_RAYTRACE::insertHole(), IsOnLayer(), layerMaskDescribe(), PCB_PARSER::parseBOARD_unchecked(), GLOBAL_EDIT_TOOL::SwapLayers(), and PNS_KICAD_IFACE_BASE::syncVia().

◆ Matches() [1/2]

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

Compare the item against the search criteria in aSearchData.

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

Parameters
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 SCH_COMPONENT, SCH_SHEET, SCH_TEXT, SCH_SHEET_PIN, SCH_FIELD, ZONE, SCH_PIN, SCH_MARKER, PCB_MARKER, FP_TEXT, and PCB_TEXT.

Definition at line 414 of file eda_item.h.

415  {
416  return false;
417  }

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

◆ Matches() [2/2]

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

133 {
134  wxString text = aText;
135  wxString searchText = aSearchData.GetFindString();
136 
137  // Don't match if searching for replaceable item and the item doesn't support text replace.
138  if( (aSearchData.GetFlags() & FR_SEARCH_REPLACE) && !IsReplaceable() )
139  return false;
140 
141  if( aSearchData.GetFlags() & wxFR_WHOLEWORD )
142  return aText.IsSameAs( searchText, aSearchData.GetFlags() & wxFR_MATCHCASE );
143 
144  if( aSearchData.GetFlags() & FR_MATCH_WILDCARD )
145  {
146  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
147  return text.Matches( searchText );
148 
149  return text.MakeUpper().Matches( searchText.MakeUpper() );
150  }
151 
152  if( aSearchData.GetFlags() & wxFR_MATCHCASE )
153  return aText.Find( searchText ) != wxNOT_FOUND;
154 
155  return text.MakeUpper().Find( searchText.MakeUpper() ) != wxNOT_FOUND;
156 }
virtual bool IsReplaceable() const
Override this method in any derived object that supports test find and replace.
Definition: eda_item.h:452

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

◆ Move() [1/2]

void TRACK::Move ( const wxPoint &  aMoveVector)
inlineoverridevirtualinherited

Move this object.

Parameters
aMoveVectorthe move vector for this object.

Reimplemented from BOARD_ITEM.

Reimplemented in ARC.

Definition at line 95 of file track.h.

96  {
97  m_Start += aMoveVector;
98  m_End += aMoveVector;
99  }
wxPoint m_Start
Line start point.
Definition: track.h:256
wxPoint m_End
Line end point.
Definition: track.h:257

References TRACK::m_End, and TRACK::m_Start.

◆ Move() [2/2]

void BOARD_ITEM::Move ( const VECTOR2I aMoveVector)
inlineinherited

Definition at line 283 of file board_item.h.

284  {
285  Move( wxPoint( aMoveVector.x, aMoveVector.y ) );
286  }
virtual void Move(const wxPoint &aMoveVector)
Move this object.
Definition: board_item.h:277

References BOARD_ITEM::Move(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ operator<()

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

Test if another item is less than this object.

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

Definition at line 185 of file eda_item.cpp.

186 {
187  wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
188  GetClass() ) );
189 
190  return false;
191 }
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
virtual wxString GetClass() const =0
Return the class name.

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

◆ Replace() [1/2]

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

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

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

160 {
161  wxString searchString = (aSearchData.GetFlags() & wxFR_MATCHCASE) ? aText : aText.Upper();
162 
163  int result = searchString.Find( (aSearchData.GetFlags() & wxFR_MATCHCASE) ?
164  aSearchData.GetFindString() :
165  aSearchData.GetFindString().Upper() );
166 
167  if( result == wxNOT_FOUND )
168  return false;
169 
170  wxString prefix = aText.Left( result );
171  wxString suffix;
172 
173  if( aSearchData.GetFindString().length() + result < aText.length() )
174  suffix = aText.Right( aText.length() - ( aSearchData.GetFindString().length() + result ) );
175 
176  wxLogTrace( traceFindReplace, wxT( "Replacing '%s', prefix '%s', replace '%s', suffix '%s'." ),
177  aText, prefix, aSearchData.GetReplaceString(), suffix );
178 
179  aText = prefix + aSearchData.GetReplaceString() + suffix;
180 
181  return true;
182 }
const wxChar *const traceFindReplace
Flag to enable find and replace debug tracing.

References traceFindReplace.

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

◆ Replace() [2/2]

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

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

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

Parameters
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_TEXT, SCH_SHEET_PIN, SCH_FIELD, and SCH_PIN.

Definition at line 441 of file eda_item.h.

442  {
443  return false;
444  }

◆ Rotate() [1/2]

void TRACK::Rotate ( const wxPoint &  aRotCentre,
double  aAngle 
)
overridevirtualinherited

Rotate this object.

Parameters
aRotCentrethe rotation point.
aAnglethe rotation angle in 0.1 degree.

Reimplemented from BOARD_ITEM.

Reimplemented in ARC.

Definition at line 266 of file track.cpp.

267 {
268  RotatePoint( &m_Start, aRotCentre, aAngle );
269  RotatePoint( &m_End, aRotCentre, aAngle );
270 }
wxPoint m_Start
Line start point.
Definition: track.h:256
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:228
wxPoint m_End
Line end point.
Definition: track.h:257

References TRACK::m_End, TRACK::m_Start, and RotatePoint().

◆ Rotate() [2/2]

void BOARD_ITEM::Rotate ( const VECTOR2I aRotCentre,
double  aAngle 
)
inlineinherited

Definition at line 299 of file board_item.h.

300  {
301  Rotate( wxPoint( aRotCentre.x, aRotCentre.y ), aAngle );
302  }
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Rotate this object.
Definition: board_item.h:294

References BOARD_ITEM::Rotate(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ SanitizeLayers()

void VIA::SanitizeLayers ( )

Function SanitizeLayers Check so that the layers are correct dependin on the type of via, and so that the top actually is on top.

Definition at line 469 of file track.cpp.

470 {
471  if( GetViaType() == VIATYPE::THROUGH )
472  {
473  m_layer = F_Cu;
475  }
476 
477  if( m_bottomLayer < m_layer )
478  std::swap( m_bottomLayer, m_layer );
479 }
VIATYPE GetViaType() const
Definition: track.h:373
PCB_LAYER_ID m_layer
Definition: board_item.h:363
PCB_LAYER_ID m_bottomLayer
The bottom layer of the via (the top layer is in m_layer)
Definition: track.h:521

References B_Cu, F_Cu, GetViaType(), m_bottomLayer, BOARD_ITEM::m_layer, and THROUGH.

Referenced by SetLayerPair(), and DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ Set() [1/3]

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

Definition at line 40 of file inspectable.h.

41  {
43  TYPE_ID thisType = TYPE_HASH( *this );
44  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
45 
46  if( object )
47  aProperty->setter( object, aValue );
48 
49  return object != nullptr;
50  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
virtual void setter(void *aObject, wxAny &aValue)=0
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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

◆ Set() [2/3]

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

Definition at line 53 of file inspectable.h.

54  {
56  TYPE_ID thisType = TYPE_HASH( *this );
57  void* object = propMgr.TypeCast( this, thisType, aProperty->OwnerHash() );
58 
59  if( object )
60  aProperty->set<T>( object, aValue );
61 
62  return object != nullptr;
63  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
void set(void *aObject, T aValue)
Definition: property.h:259
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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

◆ Set() [3/3]

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

Definition at line 66 of file inspectable.h.

67  {
69  TYPE_ID thisType = TYPE_HASH( *this );
70  PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
71  void* object = nullptr;
72 
73  if( prop )
74  {
75  object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
76 
77  if( object )
78  prop->set<T>( object, aValue );
79  }
80 
81  return object != nullptr;
82  }
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:66
#define TYPE_HASH(x)
Definition: property.h:57
size_t TYPE_ID
Unique type identifier.
Definition: property_mgr.h:43
const void * TypeCast(const void *aSource, TYPE_ID aBase, TYPE_ID aTarget) const
Cast a type to another type.
PROPERTY_BASE * GetProperty(TYPE_ID aType, const wxString &aProperty) const
Return a property for a specific type.
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:63
void set(void *aObject, T aValue)
Definition: property.h:259
virtual size_t OwnerHash() const =0
Return type-id of the Owner class.

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

◆ SetBottomLayer()

void VIA::SetBottomLayer ( PCB_LAYER_ID  aLayer)

Definition at line 429 of file track.cpp.

430 {
431  m_bottomLayer = aLayer;
432 }
PCB_LAYER_ID m_bottomLayer
The bottom layer of the via (the top layer is in m_layer)
Definition: track.h:521

References m_bottomLayer.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC(), and DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )
inlineinherited

◆ SetDrill()

◆ SetDrillDefault()

void VIA::SetDrillDefault ( )
inline

Function SetDrillDefault sets the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER.

Definition at line 495 of file track.h.

int m_drill
for vias: via drill (- 1 for default value)
Definition: track.h:525
#define UNDEFINED_DRILL_DIAMETER
Definition: track.h:77

References m_drill, and UNDEFINED_DRILL_DIAMETER.

Referenced by LEGACY_PLUGIN::loadTrackList(), FABMASTER::loadVias(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), and VIA().

◆ SetEnd()

◆ SetEndX()

void TRACK::SetEndX ( int  aX)
inlineinherited

Definition at line 118 of file track.h.

118 { m_End.x = aX; }
wxPoint m_End
Line end point.
Definition: track.h:257

References TRACK::m_End.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetEndY()

void TRACK::SetEndY ( int  aY)
inlineinherited

Definition at line 119 of file track.h.

119 { m_End.y = aY; }
wxPoint m_End
Line end point.
Definition: track.h:257

References TRACK::m_End.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetFlags()

void EDA_ITEM::SetFlags ( STATUS_FLAGS  aMask)
inlineinherited

Definition at line 202 of file eda_item.h.

202 { m_flags |= aMask; }
STATUS_FLAGS m_flags
Definition: eda_item.h:530

References EDA_ITEM::m_flags.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool  aEnable)
inlineinherited

Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

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

253 { m_forceVisible = aEnable; }
bool m_forceVisible
Definition: eda_item.h:529

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIsFree()

void VIA::SetIsFree ( bool  aFree = true)
inline

Definition at line 503 of file track.h.

503 { m_isFree = aFree; }
bool m_isFree
"Free" vias don't get their nets auto-updated
Definition: track.h:529

References m_isFree.

Referenced by PNS_KICAD_IFACE::AddItem(), DRAWING_TOOL::DrawVia(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetKeepTopBottom()

void VIA::SetKeepTopBottom ( bool  aSet)
inline

Sets whether we keep the top and bottom connections even if they are not connected.

Definition at line 452 of file track.h.

452 { m_keepTopBottomLayer = aSet; }
bool m_keepTopBottomLayer
Keep the top and bottom annular rings.
Definition: track.h:528

References m_keepTopBottomLayer.

Referenced by DIALOG_UNUSED_PAD_LAYERS::TransferDataFromWindow().

◆ SetLayer()

virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID  aLayer)
inlinevirtualinherited

Set the layer this item is on.

This method is virtual because some items (in fact: class DIMENSION) have a slightly different initialization.

Parameters
aLayerThe layer number.

Reimplemented in DIMENSION_BASE, ZONE, and PCB_GROUP.

Definition at line 194 of file board_item.h.

195  {
196  m_layer = aLayer;
197  }
PCB_LAYER_ID m_layer
Definition: board_item.h:363

References BOARD_ITEM::m_layer.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToFootprint(), PCAD2KICAD::PCB_LINE::AddToFootprint(), PCAD2KICAD::PCB_POLYGON::AddToFootprint(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BOOST_AUTO_TEST_CASE(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), MICROWAVE_TOOL::createPolygonShape(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), PAD_TOOL::explodePad(), EDIT_TOOL::FilletTracks(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), TRACK::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), FOOTPRINT::Flip(), ARC::Flip(), PCB_SHAPE::Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), CONVERT_TOOL::LinesToPoly(), LEGACY_PLUGIN::loadFOOTPRINT(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), FABMASTER::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), main(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromDrawsegments(), GRAPHICS_CLEANER::mergeRects(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageSMD(), EAGLE_PLUGIN::packageText(), EAGLE_PLUGIN::packageWire(), ALTIUM_PCB::ParseArcs6Data(), ALTIUM_PCB::ParseComponents6Data(), ALTIUM_PCB::ParseFills6Data(), GPCB_FPL_CACHE::parseFOOTPRINT(), ALTIUM_PCB::ParsePads6Data(), ALTIUM_PCB::ParseShapeBasedRegions6Data(), ALTIUM_PCB::ParseTexts6Data(), ALTIUM_PCB::ParseTracks6Data(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), CONVERT_TOOL::PolyToLines(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DIALOG_PAD_PROPERTIES::redraw(), CLIPBOARD_IO::SaveSelection(), CONVERT_TOOL::SegmentToArc(), DIMENSION_BASE::SetLayer(), FP_TEXT_GRID_TABLE::SetValueAsLong(), GLOBAL_EDIT_TOOL::swapBoardItem(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetLayerPair()

void VIA::SetLayerPair ( PCB_LAYER_ID  aTopLayer,
PCB_LAYER_ID  aBottomLayer 
)

Function SetLayerPair For a via m_layer contains the top layer, the other layer is in m_bottomLayer.

Parameters
aTopLayer= first layer connected by the via
aBottomLayer= last layer connected by the via

Definition at line 414 of file track.cpp.

415 {
416 
417  m_layer = aTopLayer;
418  m_bottomLayer = aBottomLayer;
419  SanitizeLayers();
420 }
PCB_LAYER_ID m_layer
Definition: board_item.h:363
void SanitizeLayers()
Function SanitizeLayers Check so that the layers are correct dependin on the type of via,...
Definition: track.cpp:469
PCB_LAYER_ID m_bottomLayer
The bottom layer of the via (the top layer is in m_layer)
Definition: track.h:521

References m_bottomLayer, BOARD_ITEM::m_layer, and SanitizeLayers().

Referenced by PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_PAD::AddToBoard(), DRAWING_TOOL::DrawVia(), Flip(), ROUTER_TOOL::handleLayerSwitch(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetVia(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), PCB_PARSER::parseBOARD_unchecked(), ALTIUM_PCB::ParseVias6Data(), GLOBAL_EDIT_TOOL::SwapLayers(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetLayerSet()

void VIA::SetLayerSet ( LSET  aLayers)
overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 397 of file track.cpp.

398 {
399  bool first = true;
400 
401  for( PCB_LAYER_ID layer : aLayerSet.Seq() )
402  {
403  if( first )
404  {
405  m_layer = layer;
406  first = false;
407  }
408 
409  m_bottomLayer = layer;
410  }
411 }
PCB_LAYER_ID
A quick note on layer IDs:
PCB_LAYER_ID m_layer
Definition: board_item.h:363
PCB_LAYER_ID m_bottomLayer
The bottom layer of the via (the top layer is in m_layer)
Definition: track.h:521

References m_bottomLayer, BOARD_ITEM::m_layer, and LSET::Seq().

◆ SetLocalRatsnestVisible()

void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible ( bool  aVisible)
inlineinherited

Definition at line 190 of file board_connected_item.h.

191  {
192  m_localRatsnestVisible = aVisible;
193  }

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint().

◆ SetLocked()

◆ SetModified()

void EDA_ITEM::SetModified ( )
inherited

◆ SetNet()

void BOARD_CONNECTED_ITEM::SetNet ( NETINFO_ITEM aNetInfo)
inlineinherited

◆ SetNetCode() [1/2]

bool BOARD_CONNECTED_ITEM::SetNetCode ( int  aNetCode,
bool  aNoAssert 
)
inherited

Set net using a net code.

Note
Pads not on copper layers will have their net code always set to 0 (not connected).
Parameters
aNetCodeis a net code for the new net. It has to exist in NETINFO_LIST held by BOARD.
aNoAssertif true, do not assert that the net exists. Otherwise, item is assigned to the unconnected net.
Returns
true on success, false if the net did not exist

Definition at line 43 of file board_connected_item.cpp.

44 {
45  if( !IsOnCopperLayer() )
46  aNetCode = 0;
47 
48  // if aNetCode < 0 (typically NETINFO_LIST::FORCE_ORPHANED) or no parent board,
49  // set the m_netinfo to the dummy NETINFO_LIST::ORPHANED
50 
51  BOARD* board = GetBoard();
52 
53  if( ( aNetCode >= 0 ) && board )
54  m_netinfo = board->FindNet( aNetCode );
55  else
57 
58  if( !aNoAssert )
59  wxASSERT( m_netinfo );
60 
61  return ( m_netinfo != NULL );
62 }
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
Definition: board.cpp:1268
static NETINFO_ITEM * OrphanedItem()
Wrapper class, so you can iterate through NETINFO_ITEM*s, not std::pair<int/wxString,...
Definition: netinfo.h:373
#define NULL
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
NETINFO_ITEM * m_netinfo
Store all information about the net that item belongs to.
virtual bool IsOnCopperLayer() const
Definition: board_item.h:144

References BOARD::FindNet(), BOARD_ITEM::GetBoard(), BOARD_ITEM::IsOnCopperLayer(), BOARD_CONNECTED_ITEM::m_netinfo, NULL, and NETINFO_LIST::OrphanedItem().

Referenced by BOARD::AddArea(), PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), PCAD2KICAD::PCB_PAD::AddToFootprint(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_NETLIST_UPDATER::deleteSinglePadNets(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Edit_Zone_Params(), ZONE_SETTINGS::ExportSetting(), FOOTPRINT::FOOTPRINT(), FP_ZONE::FP_ZONE(), ROUTER_TOOL::handleLayerSwitch(), FABMASTER::loadFootprints(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), DSN::SPECCTRA_DB::makeTRACK(), FOOTPRINT::operator=(), ALTIUM_PCB::ParseArcs6Data(), ALTIUM_PCB::ParseFills6Data(), ALTIUM_PCB::ParsePads6Data(), ALTIUM_PCB::ParsePolygons6Data(), ALTIUM_PCB::ParseTracks6Data(), ALTIUM_PCB::ParseVias6Data(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetNetCode() [2/2]

void BOARD_CONNECTED_ITEM::SetNetCode ( int  aNetCode)
inlineinherited

Definition at line 111 of file board_connected_item.h.

112  {
113  SetNetCode( aNetCode, false );
114  }
bool SetNetCode(int aNetCode, bool aNoAssert)
Set net using a net code.

References BOARD_CONNECTED_ITEM::SetNetCode().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM aParent)
inlinevirtualinherited

Reimplemented in DIMENSION_BASE.

Definition at line 165 of file eda_item.h.

165 { m_parent = aParent; }
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:528

References EDA_ITEM::m_parent.

Referenced by FOOTPRINT::Add(), BOARD::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewComponent(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewPart(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_PART::Flatten(), FOOTPRINT::FOOTPRINT(), GPCB_PLUGIN::FootprintLoad(), LEGACY_PLUGIN::FootprintLoad(), EAGLE_PLUGIN::FootprintLoad(), PCB_IO::FootprintLoad(), PCB_IO::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), LIB_PART::LIB_PART(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), FOOTPRINT::operator=(), LIB_PART::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), SCH_DRAWING_TOOLS::PlaceComponent(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_SEXPR_PLUGIN_CACHE::removeSymbol(), SCH_LEGACY_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_PART::SetFields(), DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_GLOBALLABEL::SwapData(), SCH_SHEET::SwapData(), SCH_COMPONENT::SwapData(), and SwapItemData().

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP aGroup)
inlineinherited

Definition at line 92 of file board_item.h.

92 { m_group = aGroup; }
PCB_GROUP * m_group
Definition: board_item.h:364

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), and PCB_GROUP::RemoveItem().

◆ SetPosition()

void VIA::SetPosition ( const wxPoint &  aPoint)
inlineoverridevirtual

◆ SetRemoveUnconnected()

void VIA::SetRemoveUnconnected ( bool  aSet)
inline

Sets the unconnected removal property.

If true, the copper is removed on zone fill or when specifically requested when the via is not connected on a layer.

Definition at line 446 of file track.h.

446 { m_removeUnconnectedLayer = aSet; }
bool m_removeUnconnectedLayer
Remove unconnected copper on a via.
Definition: track.h:527

References m_removeUnconnectedLayer.

Referenced by DIALOG_UNUSED_PAD_LAYERS::TransferDataFromWindow().

◆ SetSelected()

◆ SetStart()

◆ SetState()

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

Definition at line 191 of file eda_item.h.

192  {
193  if( state )
194  m_status |= type; // state = ON or OFF
195  else
196  m_status &= ~type;
197  }
STATUS_FLAGS m_status
Definition: eda_item.h:527

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), TRACKS_CLEANER::mergeCollinearSegments(), PCB_SELECTION_TOOL::selectConnectedTracks(), and BOARD_ITEM::SetLocked().

◆ SetStatus()

void EDA_ITEM::SetStatus ( STATUS_FLAGS  aStatus)
inlineinherited

Definition at line 200 of file eda_item.h.

200 { m_status = aStatus; }
STATUS_FLAGS m_status
Definition: eda_item.h:527

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetTopLayer()

void VIA::SetTopLayer ( PCB_LAYER_ID  aLayer)

Definition at line 423 of file track.cpp.

424 {
425  m_layer = aLayer;
426 }
PCB_LAYER_ID m_layer
Definition: board_item.h:363

References BOARD_ITEM::m_layer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ SetViaType()

◆ SetWidth()

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )
inlineinherited

Definition at line 177 of file eda_item.h.

177 { SetFlags( IS_WIRE_IMAGE ); }
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:202
#define IS_WIRE_IMAGE
Item to be drawn as wireframe while editing.
Definition: eda_item.h:110

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ SetX()

void BOARD_ITEM::SetX ( int  aX)
inlineinherited

Definition at line 119 of file board_item.h.

120  {
121  wxPoint p( aX, GetY() );
122  SetPosition( p );
123  }
virtual void SetPosition(const wxPoint &aPos)
Definition: eda_item.h:302
int GetY() const
Definition: board_item.h:103

References BOARD_ITEM::GetY(), and EDA_ITEM::SetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetY()

void BOARD_ITEM::SetY ( int  aY)
inlineinherited

Definition at line 125 of file board_item.h.

126  {
127  wxPoint p( GetX(), aY );
128  SetPosition( p );
129  }
virtual void SetPosition(const wxPoint &aPos)
Definition: eda_item.h:302
int GetX() const
Definition: board_item.h:97

References BOARD_ITEM::GetX(), and EDA_ITEM::SetPosition().

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ ShowShape()

wxString BOARD_ITEM::ShowShape ( PCB_SHAPE_TYPE_T  aShape)
staticinherited

Convert the enum PCB_SHAPE_TYPE_T integer value to a wxString.

Definition at line 31 of file board_item.cpp.

32 {
33  switch( aShape )
34  {
35  case S_SEGMENT: return _( "Line" );
36  case S_RECT: return _( "Rect" );
37  case S_ARC: return _( "Arc" );
38  case S_CIRCLE: return _( "Circle" );
39  case S_CURVE: return _( "Bezier Curve" );
40  case S_POLYGON: return _( "Polygon" );
41  default: return wxT( "??" );
42  }
43 }
polygon (not yet used for tracks, but could be in microwave apps)
Definition: board_item.h:54
usual segment : line with rounded ends
Definition: board_item.h:50
Arcs (with rounded ends)
Definition: board_item.h:52
segment with non rounded ends
Definition: board_item.h:51
#define _(s)
Definition: 3d_actions.cpp:33
ring
Definition: board_item.h:53
Bezier Curve.
Definition: board_item.h:55

References _, S_ARC, S_CIRCLE, S_CURVE, S_POLYGON, S_RECT, and S_SEGMENT.

Referenced by ConvertOutlineToPolygon(), PCB_SHAPE::GetLength(), FP_SHAPE::GetSelectMenuText(), PCB_SHAPE::GetSelectMenuText(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::Validate().

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

470 { return *aLeft < *aRight; }

◆ SwapData()

void VIA::SwapData ( BOARD_ITEM aImage)
overridevirtual

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.

Reimplemented from TRACK.

Definition at line 908 of file track.cpp.

909 {
910  assert( aImage->Type() == PCB_VIA_T );
911 
912  std::swap( *((VIA*) this), *((VIA*) aImage) );
913 }
Definition: track.h:343
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162

References PCB_VIA_T, and EDA_ITEM::Type().

◆ TopLayer()

PCB_LAYER_ID VIA::TopLayer ( ) const

◆ TransformShapeWithClearanceToPolygon()

void TRACK::TransformShapeWithClearanceToPolygon ( SHAPE_POLY_SET aCornerBuffer,
PCB_LAYER_ID  aLayer,
int  aClearanceValue,
int  aError,
ERROR_LOC  aErrorLoc,
bool  ignoreLineWidth = false 
) const
overridevirtualinherited

Function TransformShapeWithClearanceToPolygon Convert the track shape to a closed polygon Used in filling zones calculations Circles (vias) and arcs (ends of tracks) are approximated by segments.

Parameters
aCornerBuffer= a buffer to store the polygon
aClearanceValue= the clearance around the pad
aError= the maximum deviation from true circle
ignoreLineWidth= used for edge cut items where the line width is only for visualization

Reimplemented from BOARD_ITEM.

Definition at line 563 of file board_items_to_polygon_shape_transform.cpp.

567 {
568  wxASSERT_MSG( !ignoreLineWidth, "IgnoreLineWidth has no meaning for tracks." );
569 
570 
571  switch( Type() )
572  {
573  case PCB_VIA_T:
574  {
575  int radius = ( m_Width / 2 ) + aClearanceValue;
576  TransformCircleToPolygon( aCornerBuffer, m_Start, radius, aError, aErrorLoc );
577  }
578  break;
579 
580  case PCB_ARC_T:
581  {
582  const ARC* arc = static_cast<const ARC*>( this );
583  int width = m_Width + ( 2 * aClearanceValue );
584 
585  TransformArcToPolygon( aCornerBuffer, (wxPoint) arc->GetStart(), (wxPoint) arc->GetMid(),
586  (wxPoint) arc->GetEnd(), width, aError, aErrorLoc );
587  }
588  break;
589 
590  default:
591  {
592  int width = m_Width + ( 2 * aClearanceValue );
593 
594  TransformOvalToPolygon( aCornerBuffer, m_Start, m_End, width, aError, aErrorLoc );
595  }
596  break;
597  }
598 }
wxPoint m_Start
Line start point.
Definition: track.h:256
const wxPoint & GetStart() const
Definition: track.h:116
class ARC, an arc track segment on a copper layer
Definition: typeinfo.h:97
int m_Width
Thickness of track, or via diameter.
Definition: track.h:255
void TransformOvalToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aStart, wxPoint aEnd, int aWidth, int aError, ERROR_LOC aErrorLoc)
convert a oblong shape to a polygon, using multiple segments It is similar to TransformRoundedEndsSeg...
const wxPoint & GetMid() const
Definition: track.h:292
wxPoint m_End
Line end point.
Definition: track.h:257
Definition: track.h:262
void TransformCircleToPolygon(SHAPE_LINE_CHAIN &aCornerBuffer, wxPoint aCenter, int aRadius, int aError, ERROR_LOC aErrorLoc)
Function TransformCircleToPolygon convert a circle to a polygon, using multiple straight lines.
const wxPoint & GetEnd() const
Definition: track.h:113
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
void TransformArcToPolygon(SHAPE_POLY_SET &aCornerBuffer, wxPoint aStart, wxPoint aMid, wxPoint aEnd, int aWidth, int aError, ERROR_LOC aErrorLoc)
Function TransformArcToPolygon Creates a polygon from an Arc Convert arcs to multiple straight segmen...
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162

References TRACK::GetEnd(), ARC::GetMid(), TRACK::GetStart(), TRACK::m_End, TRACK::m_Start, TRACK::m_Width, PCB_ARC_T, PCB_VIA_T, TransformArcToPolygon(), TransformCircleToPolygon(), TransformOvalToPolygon(), and EDA_ITEM::Type().

Referenced by ZONE_FILLER::buildCopperItemClearances(), BOARD_ADAPTER::createLayers(), and PlotSolderMaskLayer().

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

162 { return m_structType; }
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:537

References EDA_ITEM::m_structType.

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

◆ ViewBBox()

const BOX2I TRACK::ViewBBox ( ) const
overridevirtualinherited

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

Returns
the current bounding box.

Reimplemented from EDA_ITEM.

Definition at line 559 of file track.cpp.

560 {
561  BOX2I bbox = GetBoundingBox();
562 
563  BOARD* board = GetBoard();
564 
565  if( board )
566  bbox.Inflate( 2 * board->GetDesignSettings().GetBiggestClearanceValue() );
567 
568  return bbox;
569 }
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: track.cpp:220
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:591
BOX2 handles a 2-D bounding box, built on top of an origin point and size vector, both of templated c...
Definition: box2.h:43
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190

References BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue(), BOARD_ITEM::GetBoard(), TRACK::GetBoundingBox(), BOARD::GetDesignSettings(), and BOX2< Vec >::Inflate().

◆ 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 EDIT_POINTS, DS_PROXY_VIEW_ITEM, ROUTER_PREVIEW_ITEM, KIGFX::VIEW_GROUP, KIGFX::PREVIEW::SELECTION_AREA, MY_DRAWING, KIGFX::VIEW_OVERLAY, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, BRIGHT_BOX, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, RATSNEST_VIEW_ITEM, and PCB_BRIGHT_BOX.

Definition at line 111 of file view_item.h.

112  {}

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

◆ ViewGetLayers()

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

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

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

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

Reimplemented from TRACK.

Definition at line 572 of file track.cpp.

573 {
574  aLayers[0] = LAYER_VIA_HOLES;
575  aLayers[1] = LAYER_VIA_HOLEWALLS;
576  aLayers[2] = LAYER_VIA_NETNAMES;
577 
578  // Just show it on common via & via holes layers
579  switch( GetViaType() )
580  {
581  case VIATYPE::THROUGH: aLayers[3] = LAYER_VIA_THROUGH; break;
582  case VIATYPE::BLIND_BURIED: aLayers[3] = LAYER_VIA_BBLIND; break;
583  case VIATYPE::MICROVIA: aLayers[3] = LAYER_VIA_MICROVIA; break;
584  default: aLayers[3] = LAYER_GP_OVERLAY; break;
585  }
586 
587  aCount = 4;
588 }
to draw blind/buried vias
to draw via holes (pad holes do not use this layer)
to draw usual through hole vias
VIATYPE GetViaType() const
Definition: track.h:373

References BLIND_BURIED, GetViaType(), LAYER_GP_OVERLAY, LAYER_VIA_BBLIND, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_NETNAMES, LAYER_VIA_THROUGH, MICROVIA, and THROUGH.

◆ ViewGetLOD()

double VIA::ViewGetLOD ( int  aLayer,
KIGFX::VIEW aView 
) const
overridevirtual

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

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

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

Reimplemented from TRACK.

Definition at line 591 of file track.cpp.

592 {
593  constexpr double HIDE = (double)std::numeric_limits<double>::max();
594 
595  PCB_PAINTER* painter = static_cast<PCB_PAINTER*>( aView->GetPainter() );
596  PCB_RENDER_SETTINGS* renderSettings = painter->GetSettings();
597  BOARD* board = GetBoard();
598  LSET visible = LSET::AllLayersMask();
599 
600  // Meta control for hiding all vias
601  if( !aView->IsLayerVisible( LAYER_VIAS ) )
602  return HIDE;
603 
604  // Handle board visibility (unless printing)
605  if( board && !aView->GetPrintMode() )
606  visible = board->GetVisibleLayers() & board->GetEnabledLayers();
607 
608  if( IsViaPadLayer( aLayer ) )
609  {
610  if( !FlashLayer( visible ) )
611  return HIDE;
612  }
613  else if( IsHoleLayer( aLayer ) )
614  {
615  if( !( visible & LSET::PhysicalLayersMask() ).any() )
616  return HIDE;
617  }
618  else if( IsNetnameLayer( aLayer ) )
619  {
620  if( renderSettings->GetHighContrast() )
621  {
622  // Hide netnames unless via is flashed to a high-contrast layer
623  if( !FlashLayer( renderSettings->GetPrimaryHighContrastLayer() ) )
624  return HIDE;
625  }
626  else
627  {
628  // Hide netnames unless pad is flashed to a visible layer
629  if( !FlashLayer( visible ) )
630  return HIDE;
631  }
632 
633  // Netnames will be shown only if zoom is appropriate
634  return m_Width == 0 ? HIDE : ( (double)Millimeter2iu( 10 ) / m_Width );
635  }
636 
637  // Passed all tests; show.
638  return 0.0;
639 }
bool IsViaPadLayer(LAYER_NUM aLayer)
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings Returns a bit-mask of all t...
Definition: board.cpp:461
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings Returns a bit-mask of all t...
Definition: board.cpp:447
Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:241
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:207
int m_Width
Thickness of track, or via diameter.
Definition: track.h:255
PCB specific render settings.
Definition: pcb_painter.h:64
LSET is a set of PCB_LAYER_IDs.
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
Definition: pcb_painter.h:247
bool FlashLayer(int aLayer) const
Checks to see whether the via should have a pad on the specific layer.
Definition: track.cpp:494
virtual BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
static LSET AllLayersMask()
Definition: lset.cpp:787
int GetPrintMode() const
Get the current print mode.
Definition: view.h:690
static LSET PhysicalLayersMask()
Return a mask holding all layers which are physically realized.
Definition: lset.cpp:849
Meta control for all vias opacity/visibility.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
bool IsHoleLayer(LAYER_NUM aLayer)
static constexpr int Millimeter2iu(double mm)
bool IsNetnameLayer(LAYER_NUM aLayer)
Test whether a layer is a netname layer.
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:404

References LSET::AllLayersMask(), FlashLayer(), BOARD_ITEM::GetBoard(), BOARD::GetEnabledLayers(), KIGFX::VIEW::GetPainter(), KIGFX::VIEW::GetPrintMode(), KIGFX::PCB_PAINTER::GetSettings(), BOARD::GetVisibleLayers(), IsHoleLayer(), KIGFX::VIEW::IsLayerVisible(), IsNetnameLayer(), IsViaPadLayer(), LAYER_VIAS, TRACK::m_Width, Millimeter2iu(), and LSET::PhysicalLayersMask().

◆ viewPrivData()

◆ Visit()

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

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

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

Parameters
inspectorAn INSPECTOR instance to use in the inspection.
testDataArbitrary data used by the inspector.
scanTypesWhich# KICAD_T types are of interest and the order is significant too, terminated by EOT.
Returns
SEARCH_RESULT SEARCH_QUIT if the Iterator is to stop the scan, else #SCAN_CONTINUE, and determined by the inspector.

Reimplemented from EDA_ITEM.

Definition at line 346 of file track.cpp.

347 {
348  KICAD_T stype = *scanTypes;
349 
350  // If caller wants to inspect my type
351  if( stype == Type() )
352  {
353  if( SEARCH_RESULT::QUIT == inspector( this, testData ) )
354  return SEARCH_RESULT::QUIT;
355  }
356 
358 }
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:162

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

Member Data Documentation

◆ m_bottomLayer

PCB_LAYER_ID VIA::m_bottomLayer
private

The bottom layer of the via (the top layer is in m_layer)

Definition at line 521 of file track.h.

Referenced by BottomLayer(), FlashLayer(), GetLayerSet(), LayerPair(), SanitizeLayers(), SetBottomLayer(), SetLayerPair(), SetLayerSet(), and VIA().

◆ m_drill

int VIA::m_drill
private

for vias: via drill (- 1 for default value)

Definition at line 525 of file track.h.

Referenced by GetDrill(), GetDrillValue(), IsDrillDefault(), SetDrill(), and SetDrillDefault().

◆ m_End

◆ m_flags

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible
protectedinherited

◆ m_group

PCB_GROUP* BOARD_ITEM::m_group
protectedinherited

Definition at line 364 of file board_item.h.

Referenced by BOARD_ITEM::GetParentGroup(), and BOARD_ITEM::SetParentGroup().

◆ m_isFree

bool VIA::m_isFree
private

"Free" vias don't get their nets auto-updated

Definition at line 529 of file track.h.

Referenced by GetIsFree(), SetIsFree(), and VIA().

◆ m_keepTopBottomLayer

bool VIA::m_keepTopBottomLayer
private

Keep the top and bottom annular rings.

Definition at line 528 of file track.h.

Referenced by FlashLayer(), GetKeepTopBottom(), SetKeepTopBottom(), and VIA().

◆ m_layer

◆ m_netinfo

◆ m_parent

◆ m_removeUnconnectedLayer

bool VIA::m_removeUnconnectedLayer
private

Remove unconnected copper on a via.

Definition at line 527 of file track.h.

Referenced by FlashLayer(), GetRemoveUnconnected(), SetRemoveUnconnected(), and VIA().

◆ m_Start

◆ m_status

STATUS_FLAGS EDA_ITEM::m_status
protectedinherited

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid
inherited

Definition at line 524 of file eda_item.h.

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

◆ m_viaType

VIATYPE VIA::m_viaType
private

through, blind/buried or micro

Definition at line 523 of file track.h.

Referenced by GetViaType(), IsType(), and SetViaType().

◆ m_Width

◆ ZeroOffset

wxPoint BOARD_ITEM::ZeroOffset
staticinherited

A value of wxPoint(0,0) which can be passed to the Draw() functions.

Definition at line 152 of file board_item.h.

Referenced by BOARD::GetPosition().


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