#include <pcb_track.h>

Inheritance diagram for PCB_VIA:

Public Types
enum	COMPARE_FLAGS : int { DRC = 0x01 }

Public Member Functions
	PCB_VIA (BOARD_ITEM *aParent)

	PCB_VIA (const PCB_VIA &aOther)

PCB_VIA &	operator= (const PCB_VIA &aOther)

void	CopyFrom (const BOARD_ITEM *aOther) override

bool	IsType (const std::vector< KICAD_T > &aScanTypes) const override
	Check whether the item is one of the listed types.

bool	HasValidLayerPair (int aCopperLayerCount)

VIATYPE	GetViaType () const

void	SetViaType (VIATYPE aViaType)

const PADSTACK &	Padstack () const

PADSTACK &	Padstack ()

void	SetPadstack (const PADSTACK &aPadstack)

const BOX2I	GetBoundingBox () const override
	Return the orthogonal bounding box of this object for display purposes.

const BOX2I	GetBoundingBox (PCB_LAYER_ID aLayer) const

void	SetWidth (int aWidth) override

int	GetWidth () const override

void	SetWidth (PCB_LAYER_ID aLayer, int aWidth)

int	GetWidth (PCB_LAYER_ID aLayer) const

void	SetFrontWidth (int aWidth)

int	GetFrontWidth () const

bool	HasHole () const override

bool	HasDrilledHole () const override

std::shared_ptr< SHAPE_SEGMENT >	GetEffectiveHoleShape () const override

MINOPTMAX< int >	GetWidthConstraint (wxString *aSource=nullptr) const override

MINOPTMAX< int >	GetDrillConstraint (wxString *aSource=nullptr) const

void	SetFrontTentingMode (TENTING_MODE aMode)

TENTING_MODE	GetFrontTentingMode () const

void	SetBackTentingMode (TENTING_MODE aMode)

TENTING_MODE	GetBackTentingMode () const

void	SetFrontCoveringMode (COVERING_MODE aMode)

COVERING_MODE	GetFrontCoveringMode () const

void	SetBackCoveringMode (COVERING_MODE aMode)

COVERING_MODE	GetBackCoveringMode () const

void	SetFrontPluggingMode (PLUGGING_MODE aMode)

PLUGGING_MODE	GetFrontPluggingMode () const

void	SetBackPluggingMode (PLUGGING_MODE aMode)

PLUGGING_MODE	GetBackPluggingMode () const

void	SetCappingMode (CAPPING_MODE aMode)

CAPPING_MODE	GetCappingMode () const

void	SetFillingMode (FILLING_MODE aMode)

FILLING_MODE	GetFillingMode () const

bool	IsTented (PCB_LAYER_ID aLayer) const override
	Checks if the given object is tented (its copper shape is covered by solder mask) on a given side of the board.

int	GetSolderMaskExpansion () const

PCB_LAYER_ID	GetLayer () const override
	Return the primary layer this item is on.

void	SetLayer (PCB_LAYER_ID aLayer) override
	Set the layer this item is on.

bool	IsOnLayer (PCB_LAYER_ID aLayer) const override
	Test to see if this object is on the given layer.

virtual LSET	GetLayerSet () const override
	Return a std::bitset of all layers on which the item physically resides.

virtual void	SetLayerSet (const LSET &aLayers) override
	Note SetLayerSet() initialize the first and last copper layers connected by the via.

void	SetLayerPair (PCB_LAYER_ID aTopLayer, PCB_LAYER_ID aBottomLayer)
	For a via m_layer contains the top layer, the other layer is in m_bottomLayer/.

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
	Return the 2 layers used by the via (the via actually uses all layers between these 2 layers)

PCB_LAYER_ID	TopLayer () const

PCB_LAYER_ID	BottomLayer () const

void	SanitizeLayers ()
	Check so that the layers are correct depending on the type of via, and so that the top actually is on top.

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &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.

bool	HitTest (const VECTOR2I &aPosition, int aAccuracy=0) const override
	Test if aPosition is inside or on the boundary of this item.

bool	HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
	Test if aRect intersects this item.

wxString	GetClass () const override
	Return the class name.

wxString	GetItemDescription (UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
	Return a user-visible description string of this item.

BITMAPS	GetMenuImage () const override
	Return a pointer to an image to be used in menus.

EDA_ITEM *	Clone () const override
	Create a duplicate of this item with linked list members set to NULL.

std::vector< int >	ViewGetLayers () const override
	Return the all the layers within the VIEW the object is painted on.

double	ViewGetLOD (int aLayer, const KIGFX::VIEW *aView) const override
	Return the level of detail (LOD) of the item.

void	Flip (const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
	Flip this object, i.e.

int	GetMinAnnulus (PCB_LAYER_ID aLayer, wxString *aSource) const

void	SetRemoveUnconnected (bool aSet)

bool	GetRemoveUnconnected () const

void	SetKeepStartEnd (bool aSet)

bool	GetKeepStartEnd () const

bool	ConditionallyFlashed (PCB_LAYER_ID aLayer) const

bool	FlashLayer (int aLayer) const
	Check to see whether the via should have a pad on the specific layer.

bool	FlashLayer (const LSET &aLayers) const
	Check to see if the via is present on any of the layers in the set.

void	GetOutermostConnectedLayers (PCB_LAYER_ID aTopmost, PCB_LAYER_ID aBottommost) const
	Return the top-most and bottom-most connected layers.

void	SetDrill (int aDrill)
	Set the drill value for vias.

int	GetDrill () const
	Return the local drill setting for this PCB_VIA.

int	GetDrillValue () const
	Calculate the drill value for vias (m_drill if > 0, or default drill value for the board).

void	SetDrillDefault ()
	Set the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER.

bool	GetIsFree () const
	Check if the via is a free via (as opposed to one created on a track by the router).

void	SetIsFree (bool aFree=true)

std::shared_ptr< SHAPE >	GetEffectiveShape (PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
	Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.

void	ClearZoneLayerOverrides ()

const ZONE_LAYER_OVERRIDE &	GetZoneLayerOverride (PCB_LAYER_ID aLayer) const

void	SetZoneLayerOverride (PCB_LAYER_ID aLayer, ZONE_LAYER_OVERRIDE aOverride)

double	Similarity (const BOARD_ITEM &aOther) const override
	Return a measure of how likely the other object is to represent the same object.

bool	operator== (const PCB_VIA &aOther) const

bool	operator== (const BOARD_ITEM &aOther) const override

void	Serialize (google::protobuf::Any &aContainer) const override
	Serializes this object to the given Any message.

bool	Deserialize (const google::protobuf::Any &aContainer) override
	Deserializes the given protobuf message into this object.

void	Move (const VECTOR2I &aMoveVector) override
	Move this object.

void	Rotate (const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
	Rotate this object.

virtual void	Mirror (const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
	Mirror this object relative to a given horizontal axis the layer is not changed.

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

void	SetEnd (const VECTOR2I &aEnd)

const VECTOR2I &	GetEnd () const

void	SetStart (const VECTOR2I &aStart)

const VECTOR2I &	GetStart () const

void	SetStartX (int aX)

void	SetStartY (int aY)

int	GetStartX () const

int	GetStartY () const

void	SetEndX (int aX)

void	SetEndY (int aY)

int	GetEndX () const

int	GetEndY () const

const VECTOR2I &	GetEndPoint (ENDPOINT_T aEndPoint) const
	Return the selected endpoint (start or end)

void	SetHasSolderMask (bool aVal)

bool	HasSolderMask () const

void	SetLocalSolderMaskMargin (std::optional< int > aMargin)

std::optional< int >	GetLocalSolderMaskMargin () const

virtual double	GetLength () const
	Get the length of the track using the hypotenuse calculation.

virtual double	GetDelay () const
	Get the time delay of the track.

void	TransformShapeToPolygon (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
	Convert the track shape to a closed polygon.

EDA_ITEM_FLAGS	IsPointOnEnds (const VECTOR2I &point, int min_dist=0) const
	Return 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.

bool	IsNull () const
	Return true if segment length is zero.

wxString	GetFriendlyName () const override

INSPECT_RESULT	Visit (INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes) override
	May be re-implemented for each derived class in order to handle all the types given by its member data.

bool	ApproxCollinear (const PCB_TRACK &aTrack)

const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers.

bool	IsOnCopperLayer () const override

bool	IsConnected () const override
	Returns information if the object is derived from BOARD_CONNECTED_ITEM.

NETINFO_ITEM *	GetNet () const
	Return #NET_INFO object for a given item.

void	SetNet (NETINFO_ITEM *aNetInfo)
	Set a NET_INFO object for the item.

int	GetNetCode () const

bool	SetNetCode (int aNetCode, bool aNoAssert)
	Set net using a net code.

void	SetNetCode (int aNetCode)

wxString	GetNetname () const

wxString	GetNetnameMsg () const

const wxString &	GetShortNetname () const

const wxString &	GetDisplayNetname () const

virtual int	GetOwnClearance (PCB_LAYER_ID aLayer, wxString *aSource=nullptr) const
	Return an item's "own" clearance in internal units.

virtual std::optional< int >	GetClearanceOverrides (wxString *aSource) const
	Return any clearance overrides set in the "classic" (ie: pre-rule) system.

virtual std::optional< int >	GetLocalClearance () const
	Return any local clearances set in the "classic" (ie: pre-rule) system.

virtual std::optional< int >	GetLocalClearance (wxString *aSource) const
	Return any local clearances set in the "classic" (ie: pre-rule) system.

virtual NETCLASS *	GetEffectiveNetClass () const
	Return the NETCLASS for this item.

wxString	GetNetClassName () const
	Returns the name of the effective netclass.

void	SetLocalRatsnestVisible (bool aVisible)

bool	GetLocalRatsnestVisible () const

TEARDROP_PARAMETERS &	GetTeardropParams ()

const TEARDROP_PARAMETERS &	GetTeardropParams () const

void	SetTeardropsEnabled (bool aEnable)

bool	GetTeardropsEnabled () const

void	SetTeardropBestLengthRatio (double aRatio)

double	GetTeardropBestLengthRatio () const

void	SetTeardropMaxLength (int aMaxLength)

int	GetTeardropMaxLength () const

void	SetTeardropBestWidthRatio (double aRatio)

double	GetTeardropBestWidthRatio () const

void	SetTeardropMaxWidth (int aMaxWidth)

int	GetTeardropMaxWidth () const

void	SetTeardropCurved (bool aCurve)

bool	GetTeardropCurved () const

void	SetTeardropPreferZoneConnections (bool aPrefer)

bool	GetTeardropPreferZoneConnections () const

void	SetTeardropAllowSpanTwoTracks (bool aAllow)

bool	GetTeardropAllowSpanTwoTracks () const

void	SetTeardropMaxTrackWidth (double aRatio)

double	GetTeardropMaxTrackWidth () const

int	GetX () const

int	GetY () const

virtual VECTOR2I	GetCenter () const
	This defaults to the center of the bounding box if not overridden.

void	SetX (int aX)

void	SetY (int aY)

virtual void	RunOnChildren (const std::function< void(BOARD_ITEM *)> &aFunction, RECURSE_MODE aMode) const
	Invoke a function on all children.

BOARD_ITEM_CONTAINER *	GetParent () const

FOOTPRINT *	GetParentFootprint () const

VECTOR2I	GetFPRelativePosition () const

void	SetFPRelativePosition (const VECTOR2I &aPos)

virtual bool	HasLineStroke () const
	Check if this item has line stoke properties.

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

const KIFONT::METRICS &	GetFontMetrics () const

virtual int	BoardLayerCount () const
	Return the total number of layers for the board that this item resides on.

virtual int	BoardCopperLayerCount () const
	Return the total number of copper layers for the board that this item resides on.

virtual LSET	BoardLayerSet () const
	Return the LSET for the board that this item resides on.

bool	IsSideSpecific () const

virtual BOARD_ITEM *	Duplicate () const
	Create a copy of this BOARD_ITEM.

void	SwapItemData (BOARD_ITEM *aImage)
	Swap data between aItem and aImage.

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

bool	IsLocked () const override

void	SetLocked (bool aLocked) override

virtual void	StyleFromSettings (const BOARD_DESIGN_SETTINGS &settings)

void	DeleteStructure ()
	Delete this object after removing from its parent if it has one.

virtual void	Normalize ()
	Perform any normalization required after a user rotate and/or flip.

virtual void	NormalizeForCompare ()
	Perform any normalization required to compare 2 graphics, especially if the can be rotated and/or flipped.

virtual const BOARD *	GetBoard () const
	Return the BOARD in which this BOARD_ITEM resides, or NULL if none.

virtual BOARD *	GetBoard ()

wxString	GetParentAsString () const
	For "parent" property.

wxString	GetLayerName () const
	Return the name of the PCB layer on which the item resides.

virtual void	TransformShapeToPolySet (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc) const
	Convert the item shape to a polyset.

KICAD_T	Type () const
	Returns the type of object.

virtual void	SetParent (EDA_ITEM *aParent)

virtual void	SetParentGroup (EDA_GROUP *aGroup)

virtual EDA_GROUP *	GetParentGroup () const

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetIsRollover (bool aIsRollover)

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

virtual void	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

virtual void	ClearTempFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

void	SetForceVisible (bool aEnable)
	Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is set to not visible.

bool	IsForceVisible () const

virtual VECTOR2I	GetSortPosition () const
	Return the coordinates that should be used for sorting this element visually compared to other elements.

wxString	GetTypeDesc () const
	Return a translated description of the type for this EDA_ITEM for display in user facing messages.

virtual bool	Matches (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
	Compare the item against the search criteria in aSearchData.

virtual bool	Replace (const EDA_SEARCH_DATA &aSearchData, void *aAuxData=nullptr)
	Perform a text replace using the find and replace criteria in aSearchData on items that support text find and replace.

virtual bool	IsReplaceable () const
	Override this method in any derived object that supports test find and replace.

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

virtual EMBEDDED_FILES *	GetEmbeddedFiles ()

bool	IsSCH_ITEM () const

bool	IsBOARD_ITEM () const

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

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

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)

template<class T >
static INSPECT_RESULT	IterateForward (std::deque< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	This changes first parameter to avoid the DList and use the main queue instead.

template<class T >
static INSPECT_RESULT	IterateForward (std::vector< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
	Change first parameter to avoid the DList and use std::vector instead.

static bool	Replace (const EDA_SEARCH_DATA &aSearchData, wxString &aText)
	Perform a text replace on aText using the find and replace criteria in aSearchData on items that support text find and replace.

static bool	Sort (const EDA_ITEM aLeft, const EDA_ITEM aRight)
	Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM pointers.

Public Attributes
const KIID	m_Uuid

Static Public Attributes
static VECTOR2I	ZeroOffset
	A value of wxPoint(0,0) which can be passed to the Draw() functions.

Protected Member Functions
void	swapData (BOARD_ITEM *aImage) override

wxString	layerMaskDescribe () const override
	Return a string (to be shown to the user) describing a layer mask.

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

bool	Matches (const wxString &aText, const EDA_SEARCH_DATA &aSearchData) const
	Compare aText against search criteria in aSearchData.

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

Protected Attributes
VECTOR2I	m_Start
	Line start point.

VECTOR2I	m_End
	Line end point.

bool	m_hasSolderMask

std::optional< int >	m_solderMaskMargin

NETINFO_ITEM *	m_netinfo
	Store all information about the net that item belongs to.

TEARDROP_PARAMETERS	m_teardropParams
	Not all BOARD_CONNECTED_ITEMs support teardrops, but we want those that do to share a single section in the property inspector.

PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

EDA_ITEM_FLAGS	m_flags

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

EDA_GROUP *	m_group
	The group this item belongs to.

bool	m_forceVisible

bool	m_isRollover

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

static constexpr double	LOD_SHOW = 0.0
	Return this constant from ViewGetLOD() to show the item unconditionally.

Private Member Functions
bool	operator== (const PCB_TRACK &aOther) const override

Private Attributes
VIATYPE	m_viaType
	through, blind/buried or micro

PADSTACK	m_padStack

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

std::mutex	m_zoneLayerOverridesMutex

std::map< PCB_LAYER_ID, ZONE_LAYER_OVERRIDE >	m_zoneLayerOverrides

int	m_width
	Thickness of track (or arc) – no longer the width of a via.

bool	m_localRatsnestVisible

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

bool	m_isSCH_ITEM

bool	m_isBOARD_ITEM

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items.

Detailed Description

Definition at line 412 of file pcb_track.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum BOARD_ITEM::COMPARE_FLAGS : int

inherited

Enumerator
DRC

Definition at line 426 of file board_item.h.

Constructor & Destructor Documentation

◆ PCB_VIA() [1/2]

PCB_VIA::PCB_VIA ( BOARD_ITEM * aParent )

◆ PCB_VIA() [2/2]

PCB_VIA::PCB_VIA ( const PCB_VIA & aOther )

Definition at line 127 of file pcb_track.cpp.

References EDA_ITEM::m_Uuid, m_zoneLayerOverrides, and operator=().

Member Function Documentation

◆ ApproxCollinear()

bool PCB_TRACK::ApproxCollinear ( const PCB_TRACK & aTrack )

inherited

Definition at line 541 of file pcb_track.cpp.

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

Referenced by TRACKS_CLEANER::testTrackEndpointIsNode().

◆ BoardCopperLayerCount()

int BOARD_ITEM::BoardCopperLayerCount ( ) const

virtualinherited

Return the total number of copper layers for the board that this item resides on.

Definition at line 118 of file board_item.cpp.

References BOARD_ITEM::GetBoard(), and BOARD::GetCopperLayerCount().

Referenced by PAD::ClearZoneLayerOverrides(), ClearZoneLayerOverrides(), PAD::Flip(), PADSTACK::ForEachUniqueLayer(), GetLayerSet(), PAD::PAD(), PCB_VIA(), PADSTACK::RelevantShapeLayers(), PNS_KICAD_IFACE_BASE::syncPad(), and PADSTACK::UniqueLayers().

◆ BoardLayerCount()

int BOARD_ITEM::BoardLayerCount ( ) const

virtualinherited

Return the total number of layers for the board that this item resides on.

Definition at line 107 of file board_item.cpp.

References BOARD_ITEM::GetBoard(), and BOARD::GetLayerSet().

◆ BoardLayerSet()

LSET BOARD_ITEM::BoardLayerSet ( ) const

virtualinherited

Return the LSET for the board that this item resides on.

Definition at line 129 of file board_item.cpp.

References LSET::AllLayersMask(), BOARD_ITEM::GetBoard(), and BOARD::GetEnabledLayers().

Referenced by ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper(), and PADSTACK::EffectiveLayerFor().

◆ BottomLayer()

PCB_LAYER_ID PCB_VIA::BottomLayer ( ) const

Definition at line 1385 of file pcb_track.cpp.

References PADSTACK::Drill(), PADSTACK::DRILL_PROPS::end, and Padstack().

Referenced by PCB_IO_IPC2581::addPadStack(), LENGTH_DELAY_CALCULATION_ITEM::CalculateViaLayers(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), GetOutermostConnectedLayers(), PNS_KICAD_IFACE_BASE::syncVia(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ ClassOf()

static bool PCB_VIA::ClassOf ( const EDA_ITEM * aItem )

inlinestatic

Definition at line 417 of file pcb_track.h.

References PCB_VIA_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 134 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 152 of file eda_item.h.

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

Referenced by BOARD::Add(), FOOTPRINT::Add(), LIB_SYMBOL::ClearEditFlags(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::Revert(), SCH_ITEM::SwapFlags(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 140 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), SCH_MOVE_TOOL::AlignToGrid(), SCH_DRAWING_TOOLS::AutoPlaceAllSheetPins(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConnectBoardShapes(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditRevert(), PCB_EDIT_FRAME::ExchangeFootprint(), SCH_SELECTION_TOOL::ExitGroup(), PCB_SELECTION_TOOL::ExitGroup(), SCH_IO_KICAD_SEXPR::Format(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_INTERACTIVE_COURTYARD_CLEARANCE::Init(), SCH_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), PAD::Recombine(), GERBVIEW_FRAME::RemapLayers(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_SELECTION_TOOL::selectMultiple(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_SELECTION_TOOL::unhighlight(), and SCOPED_FLAGS_CLEANER::~SCOPED_FLAGS_CLEANER().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 133 of file eda_item.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), EDIT_TOOL::Duplicate(), LIB_SYMBOL::LIB_SYMBOL(), ARRAY_TOOL::onDialogClosed(), SCH_COMMIT::Revert(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), SCH_COMMIT::Stage(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 165 of file eda_item.h.

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

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

◆ ClearZoneLayerOverrides()

void PCB_VIA::ClearZoneLayerOverrides ( )

Definition at line 1468 of file pcb_track.cpp.

References B_Cu, BOARD_ITEM::BoardCopperLayerCount(), F_Cu, m_zoneLayerOverrides, m_zoneLayerOverridesMutex, and ZLO_NONE.

◆ Clone()

EDA_ITEM * PCB_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 PCB_TRACK.

Definition at line 160 of file pcb_track.cpp.

◆ ConditionallyFlashed()

bool PCB_VIA::ConditionallyFlashed ( PCB_LAYER_ID aLayer ) const

inline

Definition at line 616 of file pcb_track.h.

References PADSTACK::Drill(), PADSTACK::DRILL_PROPS::end, PADSTACK::KEEP_ALL, m_padStack, PADSTACK::REMOVE_ALL, PADSTACK::REMOVE_EXCEPT_START_AND_END, PADSTACK::DRILL_PROPS::start, and PADSTACK::UnconnectedLayerMode().

◆ CopyFrom()

void PCB_VIA::CopyFrom ( const BOARD_ITEM * aOther )

overridevirtual

Reimplemented from PCB_TRACK.

Definition at line 153 of file pcb_track.cpp.

References PCB_VIA_T, and EDA_ITEM::Type().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 210 of file board_item.cpp.

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

◆ Deserialize()

bool PCB_VIA::Deserialize ( const google::protobuf::Any & aContainer )

overridevirtual

Deserializes the given protobuf message into this object.

Parameters

aContainer is an Any which should have a concrete type matching this object

Returns: true if unpacking and deserialization succeeded

Reimplemented from PCB_TRACK.

Definition at line 513 of file pcb_track.cpp.

References PADSTACK::Deserialize(), PCB_TRACK::GetStart(), PADSTACK::LayerSet(), m_padStack, EDA_ITEM::m_Uuid, BASE_SET::reset(), PCB_TRACK::SetEnd(), BOARD_ITEM::SetLocked(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_TRACK::SetStart(), SetViaType(), and via.

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 244 of file board_item.cpp.

References EDA_GROUP::AddItem(), EDA_ITEM::Clone(), EDA_ITEM::GetParentGroup(), and EDA_ITEM::m_Uuid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_POINT_EDITOR::addCorner(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), FOOTPRINT::Duplicate(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), and ARRAY_TOOL::onDialogClosed().

◆ FlashLayer() [1/2]

bool PCB_VIA::FlashLayer ( const LSET & aLayers ) const

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

Parameters

aLayers is the set 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 1404 of file pcb_track.cpp.

References FlashLayer().

◆ FlashLayer() [2/2]

bool PCB_VIA::FlashLayer ( int aLayer ) const

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

Parameters

aLayer Layer to check for connectivity

Returns: true if connected by pad or track (or optionally zone)

Definition at line 1416 of file pcb_track.cpp.

References PADSTACK::Drill(), PADSTACK::DRILL_PROPS::end, BOARD_ITEM::GetBoard(), BOARD::GetConnectivity(), GetZoneLayerOverride(), IsCopperLayer(), IsOnLayer(), PADSTACK::KEEP_ALL, Padstack(), PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, PADSTACK::REMOVE_ALL, PADSTACK::REMOVE_EXCEPT_START_AND_END, PADSTACK::DRILL_PROPS::start, PADSTACK::UnconnectedLayerMode(), UNDEFINED_LAYER, and ZLO_FORCE_FLASHED.

Referenced by PCB_IO_IPC2581::addPadStack(), FEATURES_MANAGER::AddVia(), PCB_IO_IPC2581::addVia(), BOARD_ADAPTER::createLayers(), KIGFX::PCB_PAINTER::draw(), FlashLayer(), GetMinAnnulus(), and ViewGetLOD().

◆ Flip()

void PCB_VIA::Flip	(	const VECTOR2I &	aCentre,
		FLIP_DIRECTION	aFlipDirection
	)

overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters

aCentre	the rotation point.
aFlipDirection	the flip direction

Reimplemented from PCB_TRACK.

Definition at line 870 of file pcb_track.cpp.

References BOARD::FlipLayer(), BOARD_ITEM::GetBoard(), GetViaType(), LayerPair(), PCB_TRACK::m_End, PCB_TRACK::m_Start, SetLayerPair(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 120 of file inspectable.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 100 of file inspectable.h.

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

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PROPERTIES_PANEL::getItemValue(), PCBEXPR_VAR_REF::GetValue(), and SCHEMATIC::SCHEMATIC().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 108 of file inspectable.h.

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

◆ GetBackCoveringMode()

COVERING_MODE PCB_VIA::GetBackCoveringMode ( ) const

Definition at line 997 of file pcb_track.cpp.

References PADSTACK::BackOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_covering, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetBackPluggingMode()

PLUGGING_MODE PCB_VIA::GetBackPluggingMode ( ) const

Definition at line 1043 of file pcb_track.cpp.

References PADSTACK::BackOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_plugging, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetBackTentingMode()

TENTING_MODE PCB_VIA::GetBackTentingMode ( ) const

Definition at line 951 of file pcb_track.cpp.

References PADSTACK::BackOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_solder_mask, and m_padStack.

Referenced by PNS_KICAD_IFACE::createBoardItem(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 62 of file board_item.cpp.

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

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 48 of file board_item.cpp.

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), BOARD_ADAPTER::addShape(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BOARD_ITEM::BoardCopperLayerCount(), BOARD_ITEM::BoardLayerCount(), BOARD_ITEM::BoardLayerSet(), CN_CONNECTIVITY_ALGO::Build(), PAD::BuildEffectivePolygon(), PAD::buildEffectiveShape(), ZONE::BuildSmoothedPoly(), collidesWithArea(), PCB_TUNING_PATTERN::CreateNew(), BOARD_INSPECTION_TOOL::DiffFootprint(), PAD::doCheckPad(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), enclosedByAreaFunc(), existsOnLayerFunc(), ZONE_FILLER::Fill(), FlashLayer(), PAD::FlashLayer(), FOOTPRINT::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_GENERATOR::Flip(), PCB_SHAPE::Flip(), PCB_TABLE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), Flip(), ZONE::Flip(), PAD::Flip(), FOOTPRINT::FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), fromToFunc(), BOARD_ITEM::GetBoard(), PCBEXPR_CONTEXT::GetBoard(), NETINFO_ITEM::GetBoundingBox(), ZONE::GetBoundingBox(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), COMPONENT_CLASS_CACHE_PROXY::GetComponentClass(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TRACK::GetDelay(), BOARD_CONNECTED_ITEM::GetDisplayNetname(), GetDrillConstraint(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), PCB_TEXT::GetEffectiveShape(), getFieldFunc(), ZONE::GetInteractingZones(), PAD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), ZONE::GetItemDescription(), FOOTPRINT::GetLayerBoundingBox(), BOARD_ITEM::GetLayerName(), GetMinAnnulus(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), GetOutermostConnectedLayers(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetOwnClearance(), PCB_MARKER::GetSeverity(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), FOOTPRINT::GetSide(), PCB_SHAPE::GetSolderMaskExpansion(), PCB_TRACK::GetSolderMaskExpansion(), GetSolderMaskExpansion(), PAD::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), PCB_TRACK::GetWidthConstraint(), GetWidthConstraint(), inDiffPairFunc(), ROUTER_TOOL::Init(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), BOARD_ITEM::IsLocked(), BOARD_ITEM::IsSideSpecific(), IsTented(), BOARD_ITEM::layerMaskDescribe(), layerMaskDescribe(), PAD::MergePrimitivesAsPolygon(), ZONE::Move(), DIALOG_TEXTBOX_PROPERTIES::onBorderChecked(), PCB_IO_EAGLE::packageWire(), padNeedsUpdate(), COMPONENT_CLASS_CACHE_PROXY::RecomputeComponentClass(), PCB_TUNING_PATTERN::recoverBaseline(), BOARD::ResolveDRCExclusions(), FOOTPRINT::ResolveTextVar(), PCB_SHAPE::SetIsProxyItem(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_DIMENSION_BASE::SetUnitsMode(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_FOOTPRINT_ASSOCIATIONS::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), ZONE::TransformSmoothedOutlineToPolygon(), PCB_SHAPE::UpdateHatching(), BOARD::UpdateRatsnestExclusions(), FOOTPRINT::ViewBBox(), PAD::ViewBBox(), PCB_TRACK::ViewBBox(), PAD::ViewGetLayers(), ViewGetLayers(), PAD::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), ViewGetLOD(), ZONE::ZONE(), zoneNeedsUpdate(), FOOTPRINT::~FOOTPRINT(), and ZONE::~ZONE().

◆ GetBoundingBox() [1/2]

const BOX2I PCB_VIA::GetBoundingBox ( ) const

overridevirtual

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

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

Reimplemented from PCB_TRACK.

Definition at line 726 of file pcb_track.cpp.

References BOX2ISafe(), PADSTACK::ForEachUniqueLayer(), GetWidth(), PCB_TRACK::m_Start, Padstack(), radius, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ZONE_FILLER::buildThermalSpokes(), and DRAWING_TOOL::DrawVia().

◆ GetBoundingBox() [2/2]

const BOX2I PCB_VIA::GetBoundingBox ( PCB_LAYER_ID aLayer ) const

Definition at line 751 of file pcb_track.cpp.

References BOX2ISafe(), GetWidth(), PCB_TRACK::m_Start, radius, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetCappingMode()

CAPPING_MODE PCB_VIA::GetCappingMode ( ) const

Definition at line 1066 of file pcb_track.cpp.

References PADSTACK::Drill(), PADSTACK::DRILL_PROPS::is_capped, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetCenter()

virtual VECTOR2I 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 FOOTPRINT, PAD, PCB_MARKER, PCB_SHAPE, and PCB_ARC.

Definition at line 109 of file board_item.h.

References EDA_ITEM::GetBoundingBox(), and BOX2< Vec >::GetCenter().

Referenced by PCB_GRID_HELPER::computeAnchors(), and PCB_SELECTION_TOOL::FindItem().

◆ GetClass()

wxString PCB_VIA::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from PCB_TRACK.

Definition at line 559 of file pcb_track.h.

◆ GetClearanceOverrides()

virtual std::optional< int > BOARD_CONNECTED_ITEM::GetClearanceOverrides ( wxString * aSource ) const

inlinevirtualinherited

Return any 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 149 of file board_connected_item.h.

Referenced by DRC_ENGINE::EvalRules().

◆ GetDelay()

double PCB_TRACK::GetDelay ( ) const

virtualinherited

Get the time delay of the track.

Returns: the delay of the track

Definition at line 776 of file pcb_track.cpp.

References LENGTH_DELAY_CALCULATION::CalculateDelay(), BOARD_ITEM::GetBoard(), BOARD::GetLengthCalculation(), LENGTH_DELAY_CALCULATION::GetLengthCalculationItem(), and PATH_OPTIMISATIONS::OptimiseViaLayers.

Referenced by PCB_TRACK::GetMsgPanelInfo().

◆ GetDisplayNetname()

const wxString & BOARD_CONNECTED_ITEM::GetDisplayNetname ( ) const

inherited

Returns: the unescaped short netname.

Definition at line 144 of file board_connected_item.cpp.

References emptyString, BOARD_ITEM::GetBoard(), NETINFO_ITEM::GetDisplayNetname(), and BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by KIGFX::PCB_PAINTER::draw(), and PCB_TRACK::ViewGetLOD().

◆ GetDrill()

int PCB_VIA::GetDrill ( ) const

inline

Return the local drill setting for this PCB_VIA.

Note: Use GetDrillValue() to get the calculated value.

Definition at line 676 of file pcb_track.h.

References PADSTACK::Drill(), m_padStack, PADSTACK::DRILL_PROPS::size, and VECTOR2< T >::x.

Referenced by PCB_SELECTION_TOOL::GuessSelectionCandidates(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetDrillConstraint()

MINOPTMAX< int > PCB_VIA::GetDrillConstraint ( wxString * aSource = nullptr ) const

Definition at line 585 of file pcb_track.cpp.

References BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), DRC_CONSTRAINT::GetName(), HOLE_SIZE_CONSTRAINT, BOARD_DESIGN_SETTINGS::m_DRCEngine, BOARD_ITEM::m_layer, and DRC_CONSTRAINT::Value().

◆ GetDrillValue()

int PCB_VIA::GetDrillValue ( ) const

Calculate the drill value for vias (m_drill if > 0, or default drill value for the board).

Returns: the calculated drill value.

Definition at line 634 of file pcb_track.cpp.

References PADSTACK::Drill(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), NETCLASS::GetuViaDrill(), NETCLASS::GetViaDrill(), GetViaType(), m_padStack, PADSTACK::DRILL_PROPS::size, and VECTOR2< T >::x.

Referenced by PCB_IO_IPC2581::addPadStack(), PCB_IO_IPC2581::addVia(), FEATURES_MANAGER::AddViaDrillHole(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), GetMsgPanelInfo(), KIGFX::PCB_PAINTER::getViaDrillSize(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), RENDER_3D_RAYTRACE_BASE::insertHole(), PNS_KICAD_IFACE_BASE::syncVia(), TRACK_VIA_DESC::TRACK_VIA_DESC(), viaSort(), and ViewGetLOD().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 144 of file eda_item.h.

References IS_BROKEN, IS_CHANGED, IS_MOVING, IS_NEW, IS_PASTED, EDA_ITEM::m_flags, and STRUCT_DELETED.

◆ GetEffectiveHoleShape()

std::shared_ptr< SHAPE_SEGMENT > PCB_VIA::GetEffectiveHoleShape ( ) const

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 911 of file pcb_track.cpp.

References PCB_TRACK::m_Start, and Padstack().

Referenced by DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetEffectiveNetClass()

NETCLASS * BOARD_CONNECTED_ITEM::GetEffectiveNetClass ( ) 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.

Definition at line 99 of file board_connected_item.cpp.

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

Referenced by PCBEXPR_NETCLASS_VALUE::AsString(), PCB_TUNING_PATTERN::CreateNew(), PCB_TUNING_PATTERN::EditStart(), PCBEXPR_NETCLASS_VALUE::EqualTo(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), GetDrillValue(), BOARD_INSPECTION_TOOL::getItemDescription(), LENGTH_DELAY_CALCULATION::GetLengthCalculationItem(), PAD::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClassName(), hasExactNetclassFunc(), hasNetclassFunc(), PCBEXPR_NETCLASS_VALUE::NotEqualTo(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > PCB_VIA::GetEffectiveShape	(	PCB_LAYER_ID	aLayer = `UNDEFINED_LAYER`,
		FLASHING	aFlash = `FLASHING::DEFAULT`
	)		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

aLayer	in case of items spanning multiple layers, only the shapes belonging to aLayer will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.
aFlash	optional parameter allowing a caller to force the pad to be flashed (or not flashed) on the current layer (default is to honour the pad's setting and the current connections for the given layer).

Reimplemented from PCB_TRACK.

Definition at line 2198 of file pcb_track.cpp.

References PCB_TRACK::GetWidth(), PCB_TRACK::m_Start, and UNDEFINED_LAYER.

Referenced by DRAWING_TOOL::DrawVia().

◆ GetEmbeddedFiles()

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )

inlinevirtualinherited

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

Definition at line 457 of file eda_item.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::Parse().

◆ GetEnd()

const VECTOR2I & PCB_TRACK::GetEnd ( ) const

inlineinherited

Definition at line 149 of file pcb_track.h.

References PCB_TRACK::m_End.

Referenced by CN_LIST::Add(), TEARDROP_MANAGER::AddTeardropsOnTracks(), PCB_TRACK::ApproxCollinear(), commonParallelProjection(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createTrackWithMargin(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_IPC2581::generateLayerSetNet(), PCB_ARC::GetEffectiveShape(), LENGTH_DELAY_CALCULATION::GetLengthCalculationItem(), getMinDist(), CONVERT_TOOL::getStartEndPoints(), PCB_TRACK::HitTest(), PCB_ARC::HitTest(), FEATURES_MANAGER::InitFeatureList(), PCB_ARC::IsDegenerated(), DSN::SPECCTRA_DB::makeARC(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), ROUTER_TOOL::NeighboringSegmentFilter(), DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), PCB_TRACK::Serialize(), PCB_ARC::Serialize(), snapToNearestTrack(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), TRACKS_CLEANER::testMergeCollinearSegments(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), TRACKS_CLEANER::testTrackEndpointIsNode(), PCB_TRACK::TransformShapeToPolygon(), PCB_CONTROL::UpdateMessagePanel(), and PCB_TRACK::ViewGetLOD().

◆ GetEndPoint()

const VECTOR2I & PCB_TRACK::GetEndPoint ( ENDPOINT_T aEndPoint ) const

inlineinherited

Return the selected endpoint (start or end)

Definition at line 167 of file pcb_track.h.

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

Referenced by BOARD::GetPad().

◆ GetEndX()

int PCB_TRACK::GetEndX ( ) const

inlineinherited

Definition at line 163 of file pcb_track.h.

References PCB_TRACK::m_End, and VECTOR2< T >::x.

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

◆ GetEndY()

int PCB_TRACK::GetEndY ( ) const

inlineinherited

Definition at line 164 of file pcb_track.h.

References PCB_TRACK::m_End, and VECTOR2< T >::y.

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

◆ GetFillingMode()

FILLING_MODE PCB_VIA::GetFillingMode ( ) const

Definition at line 1089 of file pcb_track.cpp.

References PADSTACK::Drill(), PADSTACK::DRILL_PROPS::is_filled, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 141 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), SCH_TABLE::DeleteMarkedCells(), PCB_TABLE::DeleteMarkedCells(), doConvertOutlineToPolygon(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditRevert(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::filterCollectorForHierarchy(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD::Recombine(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and PCB_TUNING_PATTERN::Update().

◆ GetFocusPosition()

const VECTOR2I PCB_TRACK::GetFocusPosition ( ) const

inlineoverridevirtualinherited

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_ARC.

Definition at line 143 of file pcb_track.h.

References PCB_TRACK::m_End, and PCB_TRACK::m_Start.

◆ GetFontMetrics()

const KIFONT::METRICS & BOARD_ITEM::GetFontMetrics ( ) const

inherited

Definition at line 101 of file board_item.cpp.

References KIFONT::METRICS::Default().

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), PCB_TEXT::getFontMetrics(), PCB_TEXTBOX::getFontMetrics(), BRDITEMS_PLOTTER::PlotBoardGraphicItem(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 165 of file view_item.h.

Referenced by KIGFX::SCH_PAINTER::draw(), EDA_ITEM::EDA_ITEM(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getRenderColor(), and EDA_ITEM::operator=().

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 328 of file board_item.cpp.

References BOARD_ITEM::GetParentFootprint(), EDA_ITEM::GetPosition(), and RotatePoint().

Referenced by PCB_IO_IPC2581::addLocationNode(), EDA_DATA::PACKAGE::AddPin(), PCB_IO_KICAD_SEXPR::format(), getMatchingTextItem(), PCB_FIELDS_GRID_TABLE::GetValue(), DIALOG_PAD_PROPERTIES::initValues(), FOOTPRINT::cmp_pads::operator()(), padNeedsUpdate(), processTextItem(), and PCB_FIELDS_GRID_TABLE::SetValue().

◆ GetFriendlyName()

wxString PCB_TRACK::GetFriendlyName ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 1778 of file pcb_track.cpp.

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

Referenced by PCB_TRACK::GetMsgPanelInfo().

◆ GetFrontCoveringMode()

COVERING_MODE PCB_VIA::GetFrontCoveringMode ( ) const

Definition at line 974 of file pcb_track.cpp.

References PADSTACK::FrontOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_covering, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetFrontPluggingMode()

PLUGGING_MODE PCB_VIA::GetFrontPluggingMode ( ) const

Definition at line 1020 of file pcb_track.cpp.

References PADSTACK::FrontOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_plugging, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetFrontTentingMode()

TENTING_MODE PCB_VIA::GetFrontTentingMode ( ) const

Definition at line 928 of file pcb_track.cpp.

References PADSTACK::FrontOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_solder_mask, and m_padStack.

Referenced by PNS_KICAD_IFACE::createBoardItem(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetFrontWidth()

int PCB_VIA::GetFrontWidth ( ) const

inline

Definition at line 468 of file pcb_track.h.

References F_Cu, and GetWidth().

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetIsFree()

bool PCB_VIA::GetIsFree ( ) const

inline

Check 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 700 of file pcb_track.h.

References m_isFree.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), and PNS_KICAD_IFACE_BASE::syncVia().

◆ GetItemDescription()

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

overridevirtual

Return a user-visible description string of this item.

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

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

Parameters

aLong indicates a long string is acceptable

Returns: The menu text string.

Reimplemented from PCB_TRACK.

Definition at line 166 of file pcb_track.cpp.

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

◆ GetKeepStartEnd()

bool PCB_VIA::GetKeepStartEnd ( ) const

inline

Definition at line 610 of file pcb_track.h.

References m_padStack, PADSTACK::REMOVE_EXCEPT_START_AND_END, and PADSTACK::UnconnectedLayerMode().

◆ GetLayer()

PCB_LAYER_ID PCB_VIA::GetLayer ( ) const

overridevirtual

Return the primary layer this item is on.

Reimplemented from BOARD_ITEM.

Definition at line 1217 of file pcb_track.cpp.

References PADSTACK::Drill(), Padstack(), and PADSTACK::DRILL_PROPS::start.

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

◆ 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 140 of file board_item.cpp.

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

◆ GetLayerSet()

LSET PCB_VIA::GetLayerSet ( ) const

overridevirtual

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

Reimplemented from PCB_TRACK.

Definition at line 1258 of file pcb_track.cpp.

References LSET::AllCuMask(), B_Cu, B_Mask, BOARD_ITEM::BoardCopperLayerCount(), end, F_Cu, F_Mask, GetViaType(), IsTented(), Padstack(), PCBNEW_LAYER_ID_START, and BASE_SET::set().

Referenced by PCB_IO_IPC2581::addPadStack(), TRACKS_CLEANER::cleanup(), DRAWING_TOOL::DrawVia(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), IsOnLayer(), Serialize(), viaSort(), and ViewGetLOD().

◆ GetLength()

double PCB_TRACK::GetLength ( ) const

virtualinherited

Get the length of the track using the hypotenuse calculation.

Returns: the length of the track

Reimplemented in PCB_ARC.

Definition at line 770 of file pcb_track.cpp.

References VECTOR2< T >::Distance(), PCB_TRACK::m_End, and PCB_TRACK::m_Start.

Referenced by TEARDROP_MANAGER::AddTeardropsOnTracks(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PCB_TRACK::GetItemDescription(), PCB_TRACK::GetMsgPanelInfo(), and DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run().

◆ GetLocalClearance() [1/2]

virtual std::optional< int > BOARD_CONNECTED_ITEM::GetLocalClearance ( ) const

inlinevirtualinherited

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

Returns: the clearance (if any is specified) in internal units.

Reimplemented in PAD, and ZONE.

Definition at line 159 of file board_connected_item.h.

Referenced by DRC_ENGINE::EvalRules().

◆ GetLocalClearance() [2/2]

virtual std::optional< int > BOARD_CONNECTED_ITEM::GetLocalClearance ( wxString * aSource ) const

inlinevirtualinherited

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

Parameters

aSource [out] optionally reports the source as a user-readable string.

Returns: the clearance (if any is specified) in internal units.

Reimplemented in PAD, and ZONE.

Definition at line 170 of file board_connected_item.h.

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const

inlineinherited

Definition at line 189 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint().

◆ GetLocalSolderMaskMargin()

std::optional< int > PCB_TRACK::GetLocalSolderMaskMargin ( ) const

inlineinherited

Definition at line 179 of file pcb_track.h.

References PCB_TRACK::m_solderMaskMargin.

Referenced by PNS_KICAD_IFACE::createBoardItem(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_IO_KICAD_SEXPR::format(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetMenuImage()

BITMAPS PCB_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 PCB_TRACK.

Definition at line 181 of file pcb_track.cpp.

◆ GetMinAnnulus()

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

Definition at line 603 of file pcb_track.cpp.

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

aFrame	is the EDA_DRAW_FRAME that displays the message panel
aList	is the list to populate.

Reimplemented from PCB_TRACK.

Definition at line 1885 of file pcb_track.cpp.

References _, PADSTACK::ALL_LAYERS, clearance, GetDrillValue(), GetLayer(), GetMinAnnulus(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetOwnClearance(), GetViaType(), GetWidth(), layerMaskDescribe(), and UNITS_PROVIDER::MessageTextFromValue().

◆ GetMsgPanelInfoBase_Common()

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

protectedinherited

Definition at line 1922 of file pcb_track.cpp.

References _, BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), BOARD_ITEM::IsLocked(), PCB_TRACK::m_End, EDA_ITEM::m_flags, PCB_TRACK::m_Start, PCB_EDIT_FRAME_NAME, UnescapeString(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ GetNet()

NETINFO_ITEM * BOARD_CONNECTED_ITEM::GetNet ( ) const

inlineinherited

Return #NET_INFO object for a given item.

Definition at line 77 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by PNS_KICAD_IFACE::createBoardItem(), EDIT_TOOL::DragArcTrack(), PCB_TUNING_PATTERN::EditStart(), EDIT_TOOL::FilletTracks(), PNS::NODE::FindItemByParent(), MODEL_ZONES_OVERVIEW_TABLE::GetValueByRow(), PCB_TUNING_PATTERN::initBaseLines(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), BOARD_EDITOR_CONTROL::RepairBoard(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetNetClassName()

wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const

inherited

Returns the name of the effective netclass.

Primarily for the use of the property system.

Definition at line 108 of file board_connected_item.cpp.

References BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), and NETCLASS::GetName().

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), and main().

◆ GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const

inherited

Returns: the net code.

Definition at line 91 of file board_connected_item.cpp.

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

◆ GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inherited

Returns: the full netname.

Definition at line 114 of file board_connected_item.cpp.

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

Referenced by STEP_PCB_MODEL::AddPadShape(), MODEL_ZONES_OVERVIEW_TABLE::ApplyFilter(), PCBEXPR_NET_VALUE::AsString(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), EXPORTER_STEP::buildGraphic3DShape(), EXPORTER_STEP::buildTrack3DShape(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PAD::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), ZONE_SEARCH_HANDLER::getResultCell(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), FABMASTER::loadZone(), CN_CLUSTER::OriginNetName(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), BRDITEMS_PLOTTER::PlotZone(), PAD::Serialize(), PCB_SHAPE::Serialize(), PCB_TRACK::Serialize(), PCB_ARC::Serialize(), Serialize(), ZONE::Serialize(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ 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 120 of file board_connected_item.cpp.

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

Referenced by PAD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TRACK::GetItemDescription(), GetItemDescription(), and ZONE::GetItemDescription().

◆ GetOutermostConnectedLayers()

void PCB_VIA::GetOutermostConnectedLayers	(	PCB_LAYER_ID *	aTopmost,
		PCB_LAYER_ID *	aBottommost
	)		const

Return the top-most and bottom-most connected layers.

Parameters

aTopmost
aBottommost

Definition at line 1492 of file pcb_track.cpp.

References BottomLayer(), BOARD_ITEM::GetBoard(), BOARD::GetConnectivity(), GetZoneLayerOverride(), PCB_ARC_T, PCB_PAD_T, PCB_TRACE_T, PCB_VIA_T, ToLAYER_ID(), TopLayer(), UNDEFINED_LAYER, and ZLO_FORCE_FLASHED.

◆ 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

aLayer	the layer in question.
aSource	[out] optionally reports the source as a user-readable string.

Returns: the clearance in internal units.

Reimplemented in PAD.

Definition at line 68 of file board_connected_item.cpp.

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(), PCB_TRACK::GetMsgPanelInfo(), GetMsgPanelInfo(), and ZONE::GetMsgPanelInfo().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( ) const

inlineinherited

Definition at line 207 of file board_item.h.

References EDA_ITEM::m_parent.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCB_EDIT_TABLE_TOOL::copyCell(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createTrackWithMargin(), BOARD_ITEM::DeleteStructure(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), BOARD_ITEM::GetBoard(), getClosestGroup(), PCB_TABLECELL::GetColumn(), BOARD_ITEM::GetParentFootprint(), PCB_TABLECELL::GetParentGroup(), PCB_TABLECELL::GetRow(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), memberOfGroupFunc(), EDIT_TOOL::MoveExact(), PAD::operator==(), PAD::PAD(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), PAD::Similarity(), BOARD_ITEM::SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), KIGFX::PCB_VIEW::Update(), PCB_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), and PAD_POINT_EDIT_BEHAVIOR::UpdatePoints().

◆ GetParentAsString()

wxString BOARD_ITEM::GetParentAsString ( ) const

inherited

For "parent" property.

Returns: the parent footprint's ref or the parent item's UUID.

Definition at line 374 of file board_item.cpp.

References KIID::AsString(), EDA_ITEM::m_parent, and EDA_ITEM::m_Uuid.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ GetParentFootprint()

FOOTPRINT * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 299 of file board_item.cpp.

References BOARD_ITEM::GetParent(), PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_TABLE_T, and EDA_ITEM::Type().

Referenced by CN_CONNECTIVITY_ALGO::Add(), PCB_IO_IPC2581::addPad(), FEATURES_MANAGER::AddPadShape(), STEP_PCB_MODEL::AddPadShape(), PCB_IO_IPC2581::addPadStack(), GRAPHICS_IMPORTER_PCBNEW::AddPolygon(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), EDIT_TOOL::DeleteItems(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), EDIT_TOOL::Duplicate(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), MULTICHANNEL_TOOL::fixupNet(), PCB_IO_KICAD_SEXPR::format(), FormatProbeItem(), PCB_IO_IPC2581::generateLayerSetNet(), PAD::GetClearanceOverrides(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TEXT::GetDrawRotation(), PAD::GetFPRelativeOrientation(), BOARD_ITEM::GetFPRelativePosition(), PAD::GetItemDescription(), PCB_FIELD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TEXT::GetItemDescription(), PCB_SHAPE::GetMenuImage(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), PAD::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), PCB_FIELDS_GRID_TABLE::GetValue(), PAD::GetZoneConnectionOverrides(), PCB_SELECTION_TOOL::grabUnconnected(), PCB_GROUP_TOOL::Group(), hasComponentClassFunc(), hash_fp_item(), PAD::ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), GENERAL_COLLECTOR::Inspect(), PCB_SHAPE::IsConnected(), PAD::IsFlipped(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), PNS_PCBNEW_RULE_RESOLVER::IsKeepout(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), DRC_ENGINE::IsNetTieExclusion(), PCB_SELECTION_TOOL::itemPassesFilter(), memberOfFootprintFunc(), memberOfSheetFunc(), memberOfSheetOrChildrenFunc(), BOARD::Move(), ARRAY_TOOL::onDialogClosed(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_SHAPE(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), PCB_IO_IPC2581::pinName(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), BRDITEMS_PLOTTER::PlotTableBorders(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), PAD_TOOL::pushPadSettings(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), PAD::Recombine(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), BOARD_COMMIT::Revert(), PAD::SameLogicalPadAs(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::Selectable(), PAD::SetFPRelativeOrientation(), BOARD_ITEM::SetFPRelativePosition(), PCB_FIELDS_GRID_TABLE::SetValue(), PAD::SharesNetTieGroup(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PCB_IO_EAGLE::transferPad(), PCB_SHAPE::UpdateHatching(), PCB_POINT_EDITOR::updateItem(), PAD::ViewGetLayers(), PCB_SHAPE::ViewGetLayers(), PCB_TEXT::ViewGetLayers(), PCB_TEXTBOX::ViewGetLayers(), PCB_FIELD::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and ZONE::ZONE().

◆ GetParentGroup()

virtual EDA_GROUP * EDA_ITEM::GetParentGroup ( ) const

inlinevirtualinherited

Reimplemented in SCH_TABLECELL, and PCB_TABLECELL.

Definition at line 114 of file eda_item.h.

References EDA_ITEM::m_group.

Referenced by SCH_GROUP::AddItem(), PCB_GROUP::AddItem(), EDIT_TOOL::DeleteItems(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), GENERATOR_TOOL::GENERATOR_TOOL(), getClosestGroup(), SCH_TABLECELL::GetParentGroup(), PCB_TABLECELL::GetParentGroup(), BOARD_ITEM::IsLocked(), memberOfGroupFunc(), TRACKS_CLEANER::mergeCollinearSegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), BOARD::Move(), SCH_EDITOR_CONTROL::Paste(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceTuningPattern(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::Remove(), FOOTPRINT::Remove(), BOARD_COMMIT::Revert(), PCB_SELECTION_TOOL::Selectable(), BOARD_ITEM::SwapItemData(), SCH_ITEM::SwapItemData(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), PCB_GROUP::WithinScope(), and SCH_GROUP::WithinScope().

◆ GetPosition()

VECTOR2I PCB_VIA::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from PCB_TRACK.

Definition at line 551 of file pcb_track.h.

References PCB_TRACK::m_Start.

Referenced by PCB_IO_IPC2581::addVia(), TRACKS_CLEANER::cleanup(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRAWING_TOOL::DrawVia(), Serialize(), and PNS_KICAD_IFACE_BASE::syncVia().

◆ GetRemoveUnconnected()

bool PCB_VIA::GetRemoveUnconnected ( ) const

inline

Definition at line 594 of file pcb_track.h.

References PADSTACK::KEEP_ALL, m_padStack, and PADSTACK::UnconnectedLayerMode().

◆ GetShortNetname()

const wxString & BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

Definition at line 136 of file board_connected_item.cpp.

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

Referenced by STEP_PCB_MODEL::AddPadShape(), PAD::IsFreePad(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetSolderMaskExpansion()

int PCB_VIA::GetSolderMaskExpansion ( ) const

Definition at line 1125 of file pcb_track.cpp.

References BOARD_ITEM::GetBoard().

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

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

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

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 272 of file eda_item.h.

References EDA_ITEM::GetPosition().

◆ GetStart()

const VECTOR2I & PCB_TRACK::GetStart ( ) const

inlineinherited

Definition at line 152 of file pcb_track.h.

References PCB_TRACK::m_Start.

Referenced by CN_LIST::Add(), TEARDROP_MANAGER::AddTeardropsOnTracks(), FEATURES_MANAGER::AddVia(), PCB_IO_IPC2581::addVia(), FEATURES_MANAGER::AddViaDrillHole(), PCB_TRACK::ApproxCollinear(), commonParallelProjection(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createTrackWithMargin(), Deserialize(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_IPC2581::generateLayerSetNet(), PCB_ARC::GetEffectiveShape(), LENGTH_DELAY_CALCULATION::GetLengthCalculationItem(), getMinDist(), CONVERT_TOOL::getStartEndPoints(), PCB_TRACK::HitTest(), HitTest(), PCB_ARC::HitTest(), FEATURES_MANAGER::InitFeatureList(), RENDER_3D_RAYTRACE_BASE::insertHole(), PCB_ARC::IsDegenerated(), DSN::SPECCTRA_DB::makeARC(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), ROUTER_TOOL::NeighboringSegmentFilter(), DRC_TEST_PROVIDER_TRACK_SEGMENT_LENGTH::Run(), DRC_TEST_PROVIDER_TRACK_WIDTH::Run(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), PCB_TRACK::Serialize(), PCB_ARC::Serialize(), snapToNearestTrack(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), TRACKS_CLEANER::testMergeCollinearSegments(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), TRACKS_CLEANER::testTrackEndpointIsNode(), PCB_TRACK::TransformShapeToPolygon(), PCB_CONTROL::UpdateMessagePanel(), ROUTER_TOOL::updateSizesAfterRouterEvent(), and PCB_TRACK::ViewGetLOD().

◆ GetStartX()

int PCB_TRACK::GetStartX ( ) const

inlineinherited

Definition at line 157 of file pcb_track.h.

References PCB_TRACK::m_Start, and VECTOR2< T >::x.

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

◆ GetStartY()

int PCB_TRACK::GetStartY ( ) const

inlineinherited

Definition at line 158 of file pcb_track.h.

References PCB_TRACK::m_Start, and VECTOR2< T >::y.

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

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 87 of file board_item.cpp.

References DEFAULT_LINE_WIDTH, EDA_ITEM::GetClass(), EDA_IU_SCALE::mmToIU(), and pcbIUScale.

Referenced by CONVERT_TOOL::CreatePolys().

◆ GetTeardropAllowSpanTwoTracks()

bool BOARD_CONNECTED_ITEM::GetTeardropAllowSpanTwoTracks ( ) const

inlineinherited

Definition at line 216 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_AllowUseTwoTracks, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropBestLengthRatio()

double BOARD_CONNECTED_ITEM::GetTeardropBestLengthRatio ( ) const

inlineinherited

Definition at line 198 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_BestLengthRatio, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropBestWidthRatio()

double BOARD_CONNECTED_ITEM::GetTeardropBestWidthRatio ( ) const

inlineinherited

Definition at line 204 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_BestWidthRatio, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropCurved()

bool BOARD_CONNECTED_ITEM::GetTeardropCurved ( ) const

inlineinherited

Definition at line 210 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_CurvedEdges, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropMaxLength()

int BOARD_CONNECTED_ITEM::GetTeardropMaxLength ( ) const

inlineinherited

Definition at line 201 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_TdMaxLen, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropMaxTrackWidth()

double BOARD_CONNECTED_ITEM::GetTeardropMaxTrackWidth ( ) const

inlineinherited

Definition at line 219 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_teardropParams, and TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropMaxWidth()

int BOARD_CONNECTED_ITEM::GetTeardropMaxWidth ( ) const

inlineinherited

Definition at line 207 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_TdMaxWidth, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropParams() [1/2]

TEARDROP_PARAMETERS & BOARD_CONNECTED_ITEM::GetTeardropParams ( )

inlineinherited

Definition at line 191 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_IO_KICAD_SEXPR::format(), DIALOG_PAD_PROPERTIES::initValues(), ZONE::operator==(), DIALOG_GLOBAL_EDIT_TEARDROPS::processItem(), ZONE::Similarity(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ GetTeardropParams() [2/2]

const TEARDROP_PARAMETERS & BOARD_CONNECTED_ITEM::GetTeardropParams ( ) const

inlineinherited

Definition at line 192 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_teardropParams.

◆ GetTeardropPreferZoneConnections()

bool BOARD_CONNECTED_ITEM::GetTeardropPreferZoneConnections ( ) const

inlineinherited

Definition at line 213 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_TdOnPadsInZones, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropsEnabled()

bool BOARD_CONNECTED_ITEM::GetTeardropsEnabled ( ) const

inlineinherited

Definition at line 195 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_Enabled, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 157 of file eda_item.h.

References CANDIDATE, CONNECTIVITY_CANDIDATE, IS_LINKED, EDA_ITEM::m_flags, SELECTED_BY_DRAG, SELECTION_CANDIDATE, and SKIP_STRUCT.

Referenced by EDA_ITEM::ClearTempFlags(), and SCH_ITEM::SwapFlags().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

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

Definition at line 365 of file eda_item.cpp.

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

Referenced by SCH_GROUP::AddItem(), PCB_GROUP::AddItem(), EDIT_TOOL::doMoveSelection(), and EDA_ITEM::GetFriendlyName().

◆ GetViaType()

VIATYPE PCB_VIA::GetViaType ( ) const

inline

Definition at line 450 of file pcb_track.h.

References m_viaType.

Referenced by TRACKS_CLEANER::cleanup(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), Flip(), GetDrillValue(), GetItemDescription(), GetLayerSet(), GetMsgPanelInfo(), LayerPair(), SanitizeLayers(), Serialize(), SetLayerSet(), PNS_KICAD_IFACE_BASE::syncVia(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ViewGetLOD().

◆ GetWidth() [1/2]

int PCB_VIA::GetWidth ( ) const

overridevirtual

Reimplemented from PCB_TRACK.

Definition at line 380 of file pcb_track.cpp.

References PADSTACK::ALL_LAYERS, m_padStack, PADSTACK::Size(), and VECTOR2< T >::x.

Referenced by PCB_IO_IPC2581::addVia(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), GetBoundingBox(), GetFrontWidth(), GetMsgPanelInfo(), HitTest(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), PNS_KICAD_IFACE_BASE::syncVia(), viaSort(), and ViewGetLOD().

◆ GetWidth() [2/2]

int PCB_VIA::GetWidth ( PCB_LAYER_ID aLayer ) const

Definition at line 394 of file pcb_track.cpp.

References m_padStack, PADSTACK::Size(), and VECTOR2< T >::x.

◆ GetWidthConstraint()

MINOPTMAX< int > PCB_VIA::GetWidthConstraint ( wxString * aSource = nullptr ) const

overridevirtual

Reimplemented from PCB_TRACK.

Definition at line 567 of file pcb_track.cpp.

References BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), DRC_CONSTRAINT::GetName(), BOARD_DESIGN_SETTINGS::m_DRCEngine, BOARD_ITEM::m_layer, DRC_CONSTRAINT::Value(), and VIA_DIAMETER_CONSTRAINT.

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 92 of file board_item.h.

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

Referenced by STEP_PCB_MODEL::AddPadShape(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), ZONE_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), BOARD_ITEM::SetY(), and ZONE_DESC::ZONE_DESC().

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 98 of file board_item.h.

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

Referenced by STEP_PCB_MODEL::AddPadShape(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), ZONE_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), BOARD_ITEM::SetX(), and ZONE_DESC::ZONE_DESC().

◆ GetZoneLayerOverride()

const ZONE_LAYER_OVERRIDE & PCB_VIA::GetZoneLayerOverride ( PCB_LAYER_ID aLayer ) const

Definition at line 1477 of file pcb_track.cpp.

References m_zoneLayerOverrides, and ZLO_NONE.

Referenced by FlashLayer(), and GetOutermostConnectedLayers().

◆ HasDrilledHole()

bool PCB_VIA::HasDrilledHole ( ) const

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 475 of file pcb_track.h.

References m_viaType.

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by BOARD::BulkRemoveStaleTeardrops(), GRAPHICS_CLEANER::cleanupShapes(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), SCH_EDIT_TOOL::DoDelete(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::Flip(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_SCREEN::MarkConnections(), PCB_TUNING_PATTERN::Mirror(), PCB_TUNING_PATTERN::Move(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), GERBVIEW_FRAME::RemapLayers(), SCH_EDIT_TOOL::Rotate(), PCB_TUNING_PATTERN::Rotate(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), PCB_SELECTION_TOOL::selectAllConnectedShapes(), SCH_SELECTION_TOOL::selectMultiple(), SCH_COMMIT::Stage(), TRACKS_CLEANER::testTrackEndpointIsNode(), and PCB_TUNING_PATTERN::ViewDraw().

◆ HasHole()

bool PCB_VIA::HasHole ( ) const

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 470 of file pcb_track.h.

◆ HasLineStroke()

virtual bool BOARD_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this item has line stoke properties.

See also: STROKE_PARAMS

Reimplemented in PCB_SHAPE.

Definition at line 219 of file board_item.h.

Referenced by CONVERT_TOOL::CreatePolys().

◆ HasSolderMask()

bool PCB_TRACK::HasSolderMask ( ) const

inlineinherited

Definition at line 176 of file pcb_track.h.

References PCB_TRACK::m_hasSolderMask.

Referenced by TEARDROP_MANAGER::AddTeardropsOnTracks(), PNS_KICAD_IFACE::createBoardItem(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_IO_KICAD_SEXPR::format(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ HasValidLayerPair()

bool PCB_VIA::HasValidLayerPair ( int aCopperLayerCount )

Returns: true if top and bottom layers are valid, depending on the copper layer count

Definition at line 1195 of file pcb_track.cpp.

References B_Cu, end, and Padstack().

Referenced by PCB_CONTROL::pruneItemLayers().

◆ HitTest() [1/2]

bool PCB_VIA::HitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy = `0`
	)		const

overridevirtual

Test if aRect intersects this item.

Parameters

aRect	A reference to a BOX2I object containing the rectangle to test.
aContained	Set to true to test for containment instead of an intersection.
aAccuracy	Increase aRect by this amount.

Returns: True if aRect contains or intersects the item bounding box.

Reimplemented from PCB_TRACK.

Definition at line 2052 of file pcb_track.cpp.

References BOX2< Vec >::Contains(), PADSTACK::ForEachUniqueLayer(), PCB_TRACK::GetStart(), GetWidth(), BOX2< Vec >::Inflate(), BOX2< Vec >::IntersectsCircle(), and Padstack().

◆ HitTest() [2/2]

bool PCB_VIA::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy = `0`
	)		const

overridevirtual

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

Parameters

aPosition	A reference to a VECTOR2I object containing the coordinates to test.
aAccuracy	Increase the item bounding box by this amount.

Returns: True if aPosition is within the item bounding box.

Reimplemented from PCB_TRACK.

Definition at line 1998 of file pcb_track.cpp.

References PADSTACK::ForEachUniqueLayer(), GetWidth(), PCB_TRACK::m_Start, Padstack(), and VECTOR2< T >::x.

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 102 of file view_item.h.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), PCB_BASE_FRAME::FocusOnItem(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_COMMIT::MakeImage(), BOARD::Move(), DRAWING_TOOL::PlaceImportedGraphics(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), EDIT_TOOL::removeNonRootItems(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), EDIT_TOOL::Swap(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), EDIT_TOOL::updateModificationPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 125 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_SELECTION_TOOL::SelectNext(), SCH_SELECTION_TOOL::SelectPrevious(), SCH_FIND_REPLACE_TOOL::UpdateFind(), and SCH_EDITOR_CONTROL::UpdateNetHighlighting().

◆ 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 PCB_SHAPE, and ZONE.

Definition at line 69 of file board_connected_item.h.

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 124 of file eda_item.h.

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 207 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_FIELD::Plot(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 76 of file board_item.cpp.

References BOARD_ITEM::GetBoard(), BOARD::GetBoardUse(), EDA_ITEM::GetParentGroup(), BOARD_ITEM::IsLocked(), and BOARD_ITEM::m_isLocked.

Referenced by PCB_CONTROL::AppendBoard(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), KI_TEST::CheckFpShape(), KI_TEST::CheckFpZone(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_IO_KICAD_SEXPR::format(), GENERATOR_TOOL::GENERATOR_TOOL(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_GROUP::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_SELECTION_CONDITIONS::HasLockedItems(), PCB_SELECTION_CONDITIONS::HasUnlockedItems(), ROUTER_TOOL::InlineDrag(), GENERAL_COLLECTOR::Inspect(), PCB_CONTROL::InteractiveDelete(), BOARD_ITEM::IsLocked(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), PCB_POINT_EDITOR::OnSelectionChange(), ZONE_SETTINGS::operator<<(), LINE_FILLET_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), DOGBONE_CORNER_ROUTINE::ProcessLinePair(), processTextItem(), PCB_SELECTION_TOOL::RequestSelection(), PCB_DIMENSION_BASE::Serialize(), PCB_SHAPE::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TRACK::Serialize(), PCB_ARC::Serialize(), Serialize(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), TRACKS_CLEANER::testMergeCollinearSegments(), DIALOG_REFERENCE_IMAGE_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), BOARD_ITEM::ViewGetLayers(), PCB_SHAPE::ViewGetLayers(), PCB_TEXT::ViewGetLayers(), PCB_TEXTBOX::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), and ViewGetLayers().

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 119 of file eda_item.h.

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 120 of file eda_item.h.

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PCB_TUNING_PATTERN::EditStart(), EDIT_TOOL::Flip(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_SCREEN::IsTerminalPoint(), SCH_POINT_EDITOR::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_SELECTION_TOOL::select(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), and PCB_TUNING_PATTERN::ViewDraw().

◆ IsNull()

bool PCB_TRACK::IsNull ( ) const

inlineinherited

Return true if segment length is zero.

Definition at line 236 of file pcb_track.h.

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

◆ IsOnCopperLayer()

bool PCB_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 274 of file pcb_track.h.

◆ IsOnLayer()

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

aLayer The layer to test for.

Returns: true if on given layer, else false.

Reimplemented from PCB_TRACK.

Definition at line 1172 of file pcb_track.cpp.

References B_Cu, B_Mask, LAYER_RANGE::Contains(), PADSTACK::Drill(), PADSTACK::DRILL_PROPS::end, end, F_Cu, F_Mask, GetLayerSet(), IsCopperLayer(), IsTented(), Padstack(), and PADSTACK::DRILL_PROPS::start.

Referenced by KIGFX::PCB_PAINTER::draw(), FlashLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), and ViewGetLayers().

◆ IsPointOnEnds()

EDA_ITEM_FLAGS PCB_TRACK::IsPointOnEnds	(	const VECTOR2I &	point,
		int	min_dist = `0`
	)		const

inherited

Return 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 649 of file pcb_track.cpp.

References VECTOR2< T >::Distance(), ENDPOINT, PCB_TRACK::m_End, PCB_TRACK::m_Start, PCB_TRACK::m_width, and STARTPOINT.

Referenced by TEARDROP_MANAGER::AddTeardropsOnTracks(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::NeighboringSegmentFilter(), and TRACKS_CLEANER::testMergeCollinearSegments().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 428 of file eda_item.h.

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 127 of file eda_item.h.

References EDA_ITEM::m_isRollover.

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

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 101 of file view_item.h.

Referenced by SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), and KIGFX::SCH_VIEW::Update().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

References EDA_ITEM::m_flags, and SELECTED.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), SCH_EDIT_TOOL::ChangeTextType(), DIALOG_CHANGE_SYMBOLS::DIALOG_CHANGE_SYMBOLS(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), KIGFX::SCH_PAINTER::drawItemBoundingBox(), DS_PROXY_UNDO_ITEM::DS_PROXY_UNDO_ITEM(), SCH_EDIT_FRAME::FlipBodyStyle(), RENDER_3D_OPENGL::get3dModelsFromFootprint(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::GetColor(), SCH_MOVE_TOOL::getConnectedDragItems(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::getRenderColor(), DIALOG_EXCHANGE_FOOTPRINTS::isMatch(), DIALOG_CHANGE_SYMBOLS::isMatch(), SCH_LINE::MergeOverlap(), SCH_EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), SCH_MOVE_TOOL::moveItem(), KIGFX::SCH_PAINTER::nonCached(), SCH_MOVE_TOOL::orthoLineDrag(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), SCH_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::RebuildSelection(), SCH_FIND_REPLACE_TOOL::ReplaceAll(), SCH_COMMIT::Revert(), SCH_EDIT_TOOL::Rotate(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), CLIPBOARD_IO::SaveSelection(), SCH_IO_KICAD_SEXPR::saveTable(), GERBVIEW_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::select(), PCB_TEST_SELECTION_TOOL::select(), SCH_SELECTION_TOOL::SelectColumns(), PCB_SELECTION_TOOL::SelectColumns(), SCH_SELECTION_TOOL::selectMultiple(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), SCH_SELECTION_TOOL::SelectRows(), PCB_SELECTION_TOOL::SelectRows(), SCH_COMMIT::Stage(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), GERBVIEW_SELECTION_TOOL::unselect(), SCH_FIND_REPLACE_TOOL::UpdateFind(), SCH_SYMBOL::UpdatePins(), PCB_TUNING_PATTERN::ViewDraw(), PCB_FIELD::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 180 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsSideSpecific()

bool BOARD_ITEM::IsSideSpecific ( ) const

inherited

Definition at line 150 of file board_item.cpp.

References BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayerSet(), LT_BACK, LT_FRONT, BOARD_ITEM::m_layer, and LSET::SideSpecificMask().

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), and PCB_DIMENSION_BASE::Mirror().

◆ IsTented()

bool PCB_VIA::IsTented ( PCB_LAYER_ID aLayer ) const

overridevirtual

Checks if the given object is tented (its copper shape is covered by solder mask) on a given side of the board.

Parameters

aLayer is the layer to check tenting mode for: F_Cu and F_Mask are treated identically as are B_Cu and B_Mask

Returns: true if the object is tented on the given side

Reimplemented from BOARD_ITEM.

Definition at line 1102 of file pcb_track.cpp.

References PADSTACK::BackOuterLayers(), PADSTACK::FrontOuterLayers(), BOARD_ITEM::GetBoard(), PADSTACK::MASK_LAYER_PROPS::has_solder_mask, IsBackLayer(), IsFrontLayer(), and m_padStack.

Referenced by GetLayerSet(), and IsOnLayer().

◆ IsType()

bool PCB_VIA::IsType ( const std::vector< KICAD_T > & aScanTypes ) const

inlineoverridevirtual

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

Returns: true if the item type is contained in the list aScanTypes

Reimplemented from EDA_ITEM.

Definition at line 427 of file pcb_track.h.

References EDA_ITEM::IsType(), m_viaType, PCB_LOCATE_BBVIA_T, PCB_LOCATE_STDVIA_T, and PCB_LOCATE_UVIA_T.

◆ IterateForward() [1/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 309 of file eda_item.h.

References EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 329 of file eda_item.h.

References EDA_ITEM::Visit().

◆ layerMaskDescribe()

wxString PCB_VIA::layerMaskDescribe ( ) const

overrideprotectedvirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 1945 of file pcb_track.cpp.

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

Referenced by GetItemDescription(), and GetMsgPanelInfo().

◆ LayerPair()

void PCB_VIA::LayerPair	(	PCB_LAYER_ID *	top_layer,
		PCB_LAYER_ID *	bottom_layer
	)		const

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

Parameters

[out]	top_layer	is storage for the first layer of the via (can be null).
[out]	bottom_layer	is storage for the last layer of the via(can be null).

Definition at line 1357 of file pcb_track.cpp.

References B_Cu, PADSTACK::Drill(), PADSTACK::DRILL_PROPS::end, F_Cu, GetViaType(), IsCopperLayerLowerThan(), Padstack(), and PADSTACK::DRILL_PROPS::start.

Referenced by KIGFX::PCB_PAINTER::draw(), Flip(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), RENDER_3D_RAYTRACE_BASE::insertHole(), layerMaskDescribe(), PNS_KICAD_IFACE_BASE::syncVia(), and ViewGetLayers().

◆ lodScaleForThreshold()

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

staticprotectedinherited

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

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

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

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

Definition at line 39 of file view_item.cpp.

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

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

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

Returns: True if the item's text matches the search criteria in aSearchData.

Reimplemented in SCH_MARKER, SCH_FIELD, SCH_LABEL_BASE, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, FOOTPRINT, NETINFO_ITEM, PCB_FIELD, PCB_MARKER, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 390 of file eda_item.h.

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

aText	A reference to a wxString object containing the string to test.
aSearchData	The criteria to search against.

Returns: True if aText matches the search criteria in aSearchData.

Definition at line 133 of file eda_item.cpp.

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

◆ Mirror()

void PCB_TRACK::Mirror	(	const VECTOR2I &	aCentre,
		FLIP_DIRECTION	aFlipDirection
	)

overridevirtualinherited

Mirror this object relative to a given horizontal axis the layer is not changed.

Parameters

aCentre	the mirror point.
aMirrorAroundXAxis	mirror across X axis instead of Y (the default).

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_ARC.

Definition at line 809 of file pcb_track.cpp.

References PCB_TRACK::m_End, PCB_TRACK::m_Start, and MIRROR().

◆ Move()

void PCB_TRACK::Move ( const VECTOR2I & aMoveVector )

inlineoverridevirtualinherited

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_ARC.

Definition at line 129 of file pcb_track.h.

References PCB_TRACK::m_End, and PCB_TRACK::m_Start.

◆ Normalize()

virtual void BOARD_ITEM::Normalize ( )

inlinevirtualinherited

Perform any normalization required after a user rotate and/or flip.

Reimplemented in PCB_SHAPE, and PCB_TABLE.

Definition at line 365 of file board_item.h.

Referenced by EDIT_TOOL::Flip(), BOARD_ITEM::NormalizeForCompare(), and EDIT_TOOL::Rotate().

◆ NormalizeForCompare()

virtual void BOARD_ITEM::NormalizeForCompare ( )

inlinevirtualinherited

Perform any normalization required to compare 2 graphics, especially if the can be rotated and/or flipped.

Similar to Normalize(), but more changes can be made

Reimplemented in PCB_SHAPE.

Definition at line 372 of file board_item.h.

References BOARD_ITEM::Normalize().

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

References EDA_ITEM::GetClass().

◆ operator=()

PCB_VIA & PCB_VIA::operator= ( const PCB_VIA & aOther )

Definition at line 138 of file pcb_track.cpp.

References PCB_TRACK::m_End, m_isFree, m_padStack, PCB_TRACK::m_Start, m_viaType, and EDA_ITEM::operator=().

Referenced by PCB_VIA().

◆ operator==() [1/3]

bool PCB_VIA::operator== ( const BOARD_ITEM & aOther ) const

overridevirtual

Reimplemented from PCB_TRACK.

Definition at line 308 of file pcb_track.cpp.

References EDA_ITEM::Type().

◆ operator==() [2/3]

bool PCB_VIA::operator== ( const PCB_TRACK & aOther ) const

overrideprivatevirtual

Reimplemented from PCB_TRACK.

Definition at line 319 of file pcb_track.cpp.

References EDA_ITEM::Type().

◆ operator==() [3/3]

bool PCB_VIA::operator== ( const PCB_VIA & aOther ) const

Definition at line 330 of file pcb_track.cpp.

References PCB_TRACK::m_End, BOARD_ITEM::m_layer, m_padStack, PCB_TRACK::m_Start, m_viaType, and m_zoneLayerOverrides.

◆ Padstack() [1/2]

PADSTACK & PCB_VIA::Padstack ( )

inline

Definition at line 454 of file pcb_track.h.

References m_padStack.

◆ Padstack() [2/2]

const PADSTACK & PCB_VIA::Padstack ( ) const

inline

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 170 of file eda_item.h.

◆ Replace() [1/2]

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

inlinevirtualinherited

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

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

Parameters

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

Returns: True if the item text was modified, otherwise false.

Reimplemented in SCH_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 417 of file eda_item.h.

◆ Replace() [2/2]

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

staticinherited

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

Parameters

aSearchData	A reference to a wxFindReplaceData object containing the search and replace criteria.
aText	A reference to a wxString object containing the text to be replaced.

Returns: True if aText was modified, otherwise false.

Definition at line 211 of file eda_item.cpp.

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

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

◆ Rotate()

void PCB_TRACK::Rotate	(	const VECTOR2I &	aRotCentre,
		const EDA_ANGLE &	aAngle
	)

overridevirtualinherited

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_ARC.

Definition at line 794 of file pcb_track.cpp.

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

◆ RunOnChildren()

virtual void BOARD_ITEM::RunOnChildren	(	const std::function< void(BOARD_ITEM *)> &	aFunction,
		RECURSE_MODE	aMode
	)		const

inlinevirtualinherited

Invoke a function on all children.

Note: This function should not add or remove items to the parent.

Reimplemented in BOARD, FOOTPRINT, PCB_GROUP, and PCB_TABLE.

Definition at line 205 of file board_item.h.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::Duplicate(), PCB_BASE_FRAME::FocusOnItems(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), ARRAY_TOOL::onDialogClosed(), PCB_IO_KICAD_SEXPR_PARSER::Parse(), BOARD_COMMIT::propagateDamage(), BOARD_COMMIT::Push(), PCB_GRID_HELPER::queryVisible(), PCB_SELECTION_TOOL::RequestSelection(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), and PCB_SELECTION::updateDrawList().

◆ SanitizeLayers()

void PCB_VIA::SanitizeLayers ( )

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

Definition at line 1391 of file pcb_track.cpp.

References B_Cu, PADSTACK::Drill(), PADSTACK::DRILL_PROPS::end, end, F_Cu, GetViaType(), IsCopperLayerLowerThan(), Padstack(), and PADSTACK::DRILL_PROPS::start.

Referenced by SetLayerPair().

◆ Serialize()

void PCB_VIA::Serialize ( google::protobuf::Any & aContainer ) const

overridevirtual

Serializes this object to the given Any message.

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

Parameters

aContainer will be filled with a message describing this object

Reimplemented from PCB_TRACK.

Definition at line 485 of file pcb_track.cpp.

References KIID::AsStdString(), GetLayerSet(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), GetPosition(), GetViaType(), BOARD_ITEM::IsLocked(), EDA_ITEM::m_Uuid, kiapi::board::PackLayerSet(), Padstack(), PADSTACK::Serialize(), and via.

◆ Set() [1/3]

template<typename T >

bool INSPECTABLE::Set	(	const wxString &	aProperty,
		T	aValue,
		bool	aNotify = `true`
	)

inlineinherited

Definition at line 77 of file inspectable.h.

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

◆ Set() [2/3]

template<typename T >

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		T	aValue,
		bool	aNotify = `true`
	)

inlineinherited

Definition at line 60 of file inspectable.h.

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 43 of file inspectable.h.

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

Referenced by SCH_PROPERTIES_PANEL::valueChanged(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ SetBackCoveringMode()

void PCB_VIA::SetBackCoveringMode ( COVERING_MODE aMode )

Definition at line 986 of file pcb_track.cpp.

References PADSTACK::BackOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_covering, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetBackPluggingMode()

void PCB_VIA::SetBackPluggingMode ( PLUGGING_MODE aMode )

Definition at line 1032 of file pcb_track.cpp.

References PADSTACK::BackOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_plugging, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetBackTentingMode()

void PCB_VIA::SetBackTentingMode ( TENTING_MODE aMode )

Definition at line 940 of file pcb_track.cpp.

References PADSTACK::BackOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_solder_mask, and m_padStack.

Referenced by PNS_KICAD_IFACE::createBoardItem(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetBottomLayer()

void PCB_VIA::SetBottomLayer ( PCB_LAYER_ID aLayer )

Definition at line 1351 of file pcb_track.cpp.

References PADSTACK::Drill(), PADSTACK::DRILL_PROPS::end, and Padstack().

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 131 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetCappingMode()

void PCB_VIA::SetCappingMode ( CAPPING_MODE aMode )

Definition at line 1055 of file pcb_track.cpp.

References PADSTACK::Drill(), PADSTACK::DRILL_PROPS::is_capped, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetDrill()

void PCB_VIA::SetDrill ( int aDrill )

inline

Set the drill value for vias.

Parameters

aDrill is the new drill diameter

Definition at line 666 of file pcb_track.h.

References PADSTACK::Drill(), m_padStack, and PADSTACK::DRILL_PROPS::size.

Referenced by PNS_KICAD_IFACE::createBoardItem(), FABMASTER::loadVias(), PNS_KICAD_IFACE::modifyBoardItem(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetDrillDefault()

void PCB_VIA::SetDrillDefault ( )

inline

Set the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER.

Definition at line 688 of file pcb_track.h.

References PADSTACK::Drill(), m_padStack, PADSTACK::DRILL_PROPS::size, and UNDEFINED_DRILL_DIAMETER.

Referenced by FABMASTER::loadVias(), and PCB_VIA().

◆ SetEnd()

void PCB_TRACK::SetEnd ( const VECTOR2I & aEnd )

inlineinherited

◆ SetEndX()

void PCB_TRACK::SetEndX ( int aX )

inlineinherited

Definition at line 160 of file pcb_track.h.

References PCB_TRACK::m_End, and VECTOR2< T >::x.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetEndY()

void PCB_TRACK::SetEndY ( int aY )

inlineinherited

Definition at line 161 of file pcb_track.h.

References PCB_TRACK::m_End, and VECTOR2< T >::y.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetFillingMode()

void PCB_VIA::SetFillingMode ( FILLING_MODE aMode )

Definition at line 1078 of file pcb_track.cpp.

References PADSTACK::Drill(), PADSTACK::DRILL_PROPS::is_filled, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 138 of file eda_item.h.

References EDA_ITEM::m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 160 of file view_item.h.

Referenced by EDA_ITEM::EDA_ITEM(), SYMBOL_DIFF_WIDGET::onSlider(), FOOTPRINT_DIFF_WIDGET::onSlider(), and EDA_ITEM::operator=().

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

aEnable True forces the item to be drawn. False uses the item's visibility setting to determine if the item is to be drawn.

Definition at line 206 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

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

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 342 of file board_item.cpp.

References BOARD_ITEM::GetParentFootprint(), RotatePoint(), and EDA_ITEM::SetPosition().

Referenced by PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), processTextItem(), and PCB_FIELDS_GRID_TABLE::SetValue().

◆ SetFrontCoveringMode()

void PCB_VIA::SetFrontCoveringMode ( COVERING_MODE aMode )

Definition at line 963 of file pcb_track.cpp.

References PADSTACK::FrontOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_covering, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetFrontPluggingMode()

void PCB_VIA::SetFrontPluggingMode ( PLUGGING_MODE aMode )

Definition at line 1009 of file pcb_track.cpp.

References PADSTACK::FrontOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_plugging, and m_padStack.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetFrontTentingMode()

void PCB_VIA::SetFrontTentingMode ( TENTING_MODE aMode )

Definition at line 917 of file pcb_track.cpp.

References PADSTACK::FrontOuterLayers(), PADSTACK::MASK_LAYER_PROPS::has_solder_mask, and m_padStack.

Referenced by PNS_KICAD_IFACE::createBoardItem(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetFrontWidth()

void PCB_VIA::SetFrontWidth ( int aWidth )

inline

Definition at line 467 of file pcb_track.h.

References F_Cu, and SetWidth().

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetHasSolderMask()

void PCB_TRACK::SetHasSolderMask ( bool aVal )

inlineinherited

Definition at line 175 of file pcb_track.h.

References PCB_TRACK::m_hasSolderMask.

Referenced by PNS_KICAD_IFACE::createBoardItem(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PCB_TRACK::SetLayerSet(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetIsFree()

void PCB_VIA::SetIsFree ( bool aFree = true )

inline

Definition at line 701 of file pcb_track.h.

References m_isFree.

Referenced by PNS_KICAD_IFACE::createBoardItem(), and PNS_KICAD_IFACE::modifyBoardItem().

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Definition at line 317 of file board_item.h.

References BOARD_ITEM::m_isKnockout.

Referenced by ZONE_FILLER::addKnockout(), ALTIUM_PCB::ConvertTexts6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), MULTICHANNEL_TOOL::copyRuleAreaContents(), PCB_TEXT::Deserialize(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), PCB_TEXT_DESC::PCB_TEXT_DESC(), PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC(), and PCB_FIELDS_GRID_TABLE::SetValueAsBool().

◆ SetIsRollover()

void EDA_ITEM::SetIsRollover ( bool aIsRollover )

inlineinherited

Definition at line 128 of file eda_item.h.

References EDA_ITEM::m_isRollover.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 172 of file eda_item.h.

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

◆ SetKeepStartEnd()

void PCB_VIA::SetKeepStartEnd ( bool aSet )

inline

Deprecated:

use Padstack().SetUnconnectedLayerMode() Sets whether we keep the start and end annular rings even if they are not connected

Definition at line 603 of file pcb_track.h.

References m_padStack, PADSTACK::REMOVE_ALL, PADSTACK::REMOVE_EXCEPT_START_AND_END, and PADSTACK::SetUnconnectedLayerMode().

◆ SetLayer()

void PCB_VIA::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtual

Set the layer this item is on.

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

Parameters

aLayer The layer number.

Reimplemented from BOARD_ITEM.

Definition at line 1223 of file pcb_track.cpp.

References PADSTACK::Drill(), Padstack(), and PADSTACK::DRILL_PROPS::start.

Referenced by PNS_PCBNEW_RULE_RESOLVER::getBoardItem(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetLayerPair()

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

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

Parameters

aTopLayer	is the first layer connected by the via.
aBottomLayer	is last layer connected by the via.

Definition at line 1336 of file pcb_track.cpp.

References PADSTACK::Drill(), PADSTACK::DRILL_PROPS::end, Padstack(), SanitizeLayers(), and PADSTACK::DRILL_PROPS::start.

Referenced by PNS_KICAD_IFACE::createBoardItem(), Flip(), ROUTER_TOOL::handleLayerSwitch(), and PNS_KICAD_IFACE::modifyBoardItem().

◆ SetLayerSet()

void PCB_VIA::SetLayerSet ( const LSET & aLayers )

overridevirtual

Note SetLayerSet() initialize the first and last copper layers connected by the via.

So currently SetLayerSet ignore non copper layers

Reimplemented from PCB_TRACK.

Definition at line 1294 of file pcb_track.cpp.

References B_Cu, PADSTACK::Drill(), PADSTACK::DRILL_PROPS::end, F_Cu, GetViaType(), IsCopperLayer(), Padstack(), LSET::RunOnLayers(), and PADSTACK::DRILL_PROPS::start.

◆ SetLocalRatsnestVisible()

void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible ( bool aVisible )

inlineinherited

Definition at line 188 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

◆ SetLocalSolderMaskMargin()

void PCB_TRACK::SetLocalSolderMaskMargin ( std::optional< int > aMargin )

inlineinherited

Definition at line 178 of file pcb_track.h.

References PCB_TRACK::m_solderMaskMargin.

Referenced by PNS_KICAD_IFACE::createBoardItem(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetLocked()

void BOARD_ITEM::SetLocked ( bool aLocked )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in PCB_GROUP, and FOOTPRINT.

Definition at line 320 of file board_item.h.

References BOARD_ITEM::m_isLocked.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), PAD::Deserialize(), PCB_DIMENSION_BASE::Deserialize(), PCB_SHAPE::Deserialize(), PCB_TEXT::Deserialize(), PCB_TEXTBOX::Deserialize(), PCB_TRACK::Deserialize(), PCB_ARC::Deserialize(), Deserialize(), EDIT_TOOL::DragArcTrack(), ZONE_SETTINGS::ExportSetting(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::InlineDrag(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), DSN::SPECCTRA_DB::makeARC(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_IO_KICAD_SEXPR_PARSER::Parse(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), processTextItem(), CLIPBOARD_IO::SaveSelection(), PCB_GROUP::SetLocked(), DIALOG_REFERENCE_IMAGE_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 74 of file eda_item.cpp.

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_IO_ALTIUM::ParseASCIISchematic(), SCH_IO_ALTIUM::ParseFileHeader(), and EDA_ITEM::SetModified().

◆ SetNet()

void BOARD_CONNECTED_ITEM::SetNet ( NETINFO_ITEM * aNetInfo )

inlineinherited

Set a NET_INFO object for the item.

Definition at line 85 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by BOOST_AUTO_TEST_CASE(), PNS_KICAD_IFACE::createBoardItem(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), PNS_PCBNEW_RULE_RESOLVER::getBoardItem(), ROUTER_TOOL::handleLayerSwitch(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), FABMASTER::loadEtch(), CADSTAR_PCB_ARCHIVE_LOADER::loadNets(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), FABMASTER::loadVias(), FABMASTER::loadZone(), main(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), PNS_KICAD_IFACE::modifyBoardItem(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

◆ SetNetCode() [1/2]

void BOARD_CONNECTED_ITEM::SetNetCode ( int aNetCode )

inlineinherited

Definition at line 108 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::SetNetCode().

◆ SetNetCode() [2/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

aNetCode	is a net code for the new net. It has to exist in NETINFO_LIST held by BOARD.
aNoAssert	if 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 46 of file board_connected_item.cpp.

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

Referenced by BOARD::AddArea(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), TEARDROP_MANAGER::createTeardrop(), PAD::Deserialize(), PCB_SHAPE::Deserialize(), PCB_TRACK::Deserialize(), PCB_ARC::Deserialize(), Deserialize(), ZONE::Deserialize(), PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_EDIT_FRAME::ExchangeFootprint(), ZONE_SETTINGS::ExportSetting(), MULTICHANNEL_TOOL::fixupNet(), FOOTPRINT::FOOTPRINT(), PCB_IO_EAGLE::loadPlain(), PCB_IO_EAGLE::loadSignals(), PCB_IO_KICAD_LEGACY::loadTrackList(), DSN::SPECCTRA_DB::makeARC(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), FOOTPRINT::operator=(), PAD::SetAttribute(), PCB_SHAPE::SetLayer(), BOARD_CONNECTED_ITEM::SetNetCode(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetPadstack()

void PCB_VIA::SetPadstack ( const PADSTACK & aPadstack )

inline

Definition at line 455 of file pcb_track.h.

References m_padStack.

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and NETINFO_ITEM.

Definition at line 111 of file eda_item.h.

References EDA_ITEM::m_parent.

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

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

Definition at line 113 of file eda_item.h.

References EDA_ITEM::m_group.

Referenced by SCH_GROUP::AddItem(), PCB_GROUP::AddItem(), ZONE_FILLER::buildThermalSpokes(), COMMIT::createModified(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), PCB_IO_KICAD_SEXPR::FootprintSave(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_SYMBOL::GetOrientation(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), TRACKS_CLEANER::mergeCollinearSegments(), PCB_POINT_EDITOR::OnSelectionChange(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), SCH_GROUP::RemoveItem(), PCB_GROUP::RemoveItem(), SaveCopyOfZones(), CLIPBOARD_IO::SaveSelection(), PCB_GROUP::swapData(), SCH_GROUP::swapData(), BOARD_ITEM::SwapItemData(), SCH_ITEM::SwapItemData(), TRACKS_CLEANER::testMergeCollinearSegments(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), DIALOG_PAD_PROPERTIES::~DIALOG_PAD_PROPERTIES(), SYMBOL::~SYMBOL(), TEST_BOARD_ITEM_FIXTURE::~TEST_BOARD_ITEM_FIXTURE(), and TEST_EE_ITEM_FIXTURE::~TEST_EE_ITEM_FIXTURE().

◆ SetPosition()

void PCB_VIA::SetPosition ( const VECTOR2I & aPoint )

inlineoverridevirtual

Reimplemented from PCB_TRACK.

Definition at line 552 of file pcb_track.h.

References PCB_TRACK::m_End, and PCB_TRACK::m_Start.

Referenced by ZONE_FILLER::buildThermalSpokes(), PNS_KICAD_IFACE::createBoardItem(), FABMASTER::loadVias(), and PNS_KICAD_IFACE::modifyBoardItem().

◆ SetRemoveUnconnected()

void PCB_VIA::SetRemoveUnconnected ( bool aSet )

inline

Deprecated:

use Padstack().SetUnconnectedLayerMode() 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 587 of file pcb_track.h.

References PADSTACK::KEEP_ALL, m_padStack, PADSTACK::REMOVE_ALL, and PADSTACK::SetUnconnectedLayerMode().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 130 of file eda_item.h.

References SELECTED, and EDA_ITEM::SetFlags().

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), KIGFX::SCH_PAINTER::draw(), PL_SELECTION_TOOL::highlight(), SCH_SELECTION_TOOL::highlight(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), SCH_LINE::MergeOverlap(), DS_PROXY_UNDO_ITEM::Restore(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), GERBVIEW_SELECTION_TOOL::selectVisually(), and SCH_COMMIT::Stage().

◆ SetStart()

void PCB_TRACK::SetStart ( const VECTOR2I & aStart )

inlineinherited

Definition at line 151 of file pcb_track.h.

References PCB_TRACK::m_Start.

Referenced by PNS_KICAD_IFACE::createBoardItem(), BOARD_ADAPTER::createTrackWithMargin(), PCB_TRACK::Deserialize(), PCB_ARC::Deserialize(), Deserialize(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::FilletTracks(), PNS_PCBNEW_RULE_RESOLVER::getBoardItem(), FABMASTER::loadEtch(), DSN::SPECCTRA_DB::makeARC(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), PNS_KICAD_IFACE::modifyBoardItem(), TRACKS_CLEANER::testMergeCollinearSegments(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

◆ SetStartX()

void PCB_TRACK::SetStartX ( int aX )

inlineinherited

Definition at line 154 of file pcb_track.h.

References PCB_TRACK::m_Start, and VECTOR2< T >::x.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetStartY()

void PCB_TRACK::SetStartY ( int aY )

inlineinherited

Definition at line 155 of file pcb_track.h.

References PCB_TRACK::m_Start, and VECTOR2< T >::y.

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 95 of file board_item.cpp.

References EDA_ITEM::GetClass().

◆ SetTeardropAllowSpanTwoTracks()

void BOARD_CONNECTED_ITEM::SetTeardropAllowSpanTwoTracks ( bool aAllow )

inlineinherited

Definition at line 215 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_AllowUseTwoTracks, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropBestLengthRatio()

void BOARD_CONNECTED_ITEM::SetTeardropBestLengthRatio ( double aRatio )

inlineinherited

Definition at line 197 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_BestLengthRatio, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropBestWidthRatio()

void BOARD_CONNECTED_ITEM::SetTeardropBestWidthRatio ( double aRatio )

inlineinherited

Definition at line 203 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_BestWidthRatio, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropCurved()

void BOARD_CONNECTED_ITEM::SetTeardropCurved ( bool aCurve )

inlineinherited

Definition at line 209 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_CurvedEdges, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropMaxLength()

void BOARD_CONNECTED_ITEM::SetTeardropMaxLength ( int aMaxLength )

inlineinherited

Definition at line 200 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_TdMaxLen, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropMaxTrackWidth()

void BOARD_CONNECTED_ITEM::SetTeardropMaxTrackWidth ( double aRatio )

inlineinherited

Definition at line 218 of file board_connected_item.h.

References BOARD_CONNECTED_ITEM::m_teardropParams, and TEARDROP_PARAMETERS::m_WidthtoSizeFilterRatio.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropMaxWidth()

void BOARD_CONNECTED_ITEM::SetTeardropMaxWidth ( int aMaxWidth )

inlineinherited

Definition at line 206 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_TdMaxWidth, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropPreferZoneConnections()

void BOARD_CONNECTED_ITEM::SetTeardropPreferZoneConnections ( bool aPrefer )

inlineinherited

Definition at line 212 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_TdOnPadsInZones, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropsEnabled()

void BOARD_CONNECTED_ITEM::SetTeardropsEnabled ( bool aEnable )

inlineinherited

Definition at line 194 of file board_connected_item.h.

References TEARDROP_PARAMETERS::m_Enabled, and BOARD_CONNECTED_ITEM::m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTopLayer()

void PCB_VIA::SetTopLayer ( PCB_LAYER_ID aLayer )

Definition at line 1345 of file pcb_track.cpp.

References PADSTACK::Drill(), Padstack(), and PADSTACK::DRILL_PROPS::start.

◆ SetViaType()

void PCB_VIA::SetViaType ( VIATYPE aViaType )

inline

Definition at line 451 of file pcb_track.h.

References m_viaType.

Referenced by PNS_KICAD_IFACE::createBoardItem(), Deserialize(), ROUTER_TOOL::handleLayerSwitch(), PNS_KICAD_IFACE::modifyBoardItem(), PCB_VIA(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetWidth() [1/2]

void PCB_VIA::SetWidth ( int aWidth )

overridevirtual

Reimplemented from PCB_TRACK.

Definition at line 372 of file pcb_track.cpp.

References PADSTACK::ALL_LAYERS, m_padStack, and PADSTACK::SetSize().

Referenced by PNS_KICAD_IFACE::createBoardItem(), FABMASTER::loadVias(), PNS_KICAD_IFACE::modifyBoardItem(), and SetFrontWidth().

◆ SetWidth() [2/2]

void PCB_VIA::SetWidth	(	PCB_LAYER_ID	aLayer,
		int	aWidth
	)

Definition at line 388 of file pcb_track.cpp.

References m_padStack, and PADSTACK::SetSize().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 114 of file board_item.h.

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

Referenced by FOOTPRINT::AutoPositionFields(), and BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 120 of file board_item.h.

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

Referenced by FOOTPRINT::AutoPositionFields(), and BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ SetZoneLayerOverride()

void PCB_VIA::SetZoneLayerOverride	(	PCB_LAYER_ID	aLayer,
		ZONE_LAYER_OVERRIDE	aOverride
	)

Definition at line 1485 of file pcb_track.cpp.

References m_zoneLayerOverrides, and m_zoneLayerOverridesMutex.

◆ Similarity()

double PCB_VIA::Similarity ( const BOARD_ITEM & aItem ) const

overridevirtual

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

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

This is a pure virtual function. Derived classes must implement this.

Reimplemented from PCB_TRACK.

Definition at line 341 of file pcb_track.cpp.

References PCB_TRACK::m_End, BOARD_ITEM::m_layer, m_padStack, PCB_TRACK::m_Start, m_viaType, m_zoneLayerOverrides, and EDA_ITEM::Type().

◆ Sort()

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

inlinestaticinherited

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

Parameters

aLeft	The left hand item to compare.
aRight	The right hand item to compare.

Returns: True if aLeft is less than aRight.

Definition at line 446 of file eda_item.h.

◆ StyleFromSettings()

virtual void BOARD_ITEM::StyleFromSettings ( const BOARD_DESIGN_SETTINGS & settings )

inlinevirtualinherited

Reimplemented in PCB_SHAPE, PCB_TEXT, and PCB_TEXTBOX.

Definition at line 322 of file board_item.h.

◆ swapData()

void PCB_VIA::swapData ( BOARD_ITEM * aImage )

overrideprotectedvirtual

Reimplemented from PCB_TRACK.

Definition at line 2107 of file pcb_track.cpp.

References PCB_VIA_T, and EDA_ITEM::Type().

◆ SwapItemData()

void BOARD_ITEM::SwapItemData ( BOARD_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

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

Parameters

aImage the item image which contains data to swap.

Definition at line 226 of file board_item.cpp.

References BOARD_ITEM::GetParent(), EDA_ITEM::GetParentGroup(), group, EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), and BOARD_ITEM::swapData().

Referenced by PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::Revert(), and UpdateCopyOfZonesList().

◆ TopLayer()

PCB_LAYER_ID PCB_VIA::TopLayer ( ) const

Definition at line 1379 of file pcb_track.cpp.

References PADSTACK::Drill(), Padstack(), and PADSTACK::DRILL_PROPS::start.

Referenced by PCB_IO_IPC2581::addPadStack(), LENGTH_DELAY_CALCULATION_ITEM::CalculateViaLayers(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), GetOutermostConnectedLayers(), and PNS_KICAD_IFACE_BASE::syncVia().

◆ TransformShapeToPolygon()

void PCB_TRACK::TransformShapeToPolygon	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc,
		bool	ignoreLineWidth = `false`
	)		const

overridevirtualinherited

Convert the track shape to a closed polygon.

Circles (vias) and arcs (ends of tracks) are approximated by segments.

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 2246 of file pcb_track.cpp.

References PCB_TRACK::GetEnd(), PCB_ARC::GetMid(), PCB_TRACK::GetSolderMaskExpansion(), PCB_TRACK::GetStart(), PCB_TRACK::GetWidth(), IsSolderMaskLayer(), PCB_TRACK::m_End, PCB_TRACK::m_Start, PCB_TRACK::m_width, PCB_ARC_T, PCB_VIA_T, radius, TransformArcToPolygon(), TransformCircleToPolygon(), TransformOvalToPolygon(), and EDA_ITEM::Type().

Referenced by EXPORTER_STEP::buildTrack3DShape(), BOARD_ADAPTER::createLayers(), and CONVERT_TOOL::makePolysFromOpenGraphics().

◆ TransformShapeToPolySet()

virtual void BOARD_ITEM::TransformShapeToPolySet	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc
	)		const

inlinevirtualinherited

Convert the item shape to a polyset.

Circles and arcs are approximated by segments; hatched fills will be included.

Parameters

aBuffer	a buffer to store the polygon.
aClearance	the clearance around the pad.
aError	the maximum deviation from true circle.
aErrorLoc	should the approximation error be placed outside or inside the polygon?
ignoreLineWidth	used for edge cut items where the line width is only for visualization.

Reimplemented in PCB_SHAPE.

Definition at line 420 of file board_item.h.

References BOARD_ITEM::TransformShapeToPolygon().

Referenced by DIALOG_BOARD_STATISTICS::getDataFromPCB(), and PCB_TRACK::GetMsgPanelInfo().

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

References EDA_ITEM::m_structType.

◆ ViewBBox()

const BOX2I PCB_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 1612 of file pcb_track.cpp.

References BOARD_ITEM::GetBoard(), PCB_TRACK::GetBoundingBox(), PCB_TRACK::GetWidth(), 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

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

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

Definition at line 121 of file view_item.h.

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

◆ ViewGetLayers()

std::vector< int > PCB_VIA::ViewGetLayers ( ) 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.

Reimplemented from PCB_TRACK.

Definition at line 1625 of file pcb_track.cpp.

References LSET::AllCuMask(), B_Cu, B_Mask, LSET::Contains(), end, F_Cu, F_Mask, BOARD_ITEM::GetBoard(), BOARD_ITEM::IsLocked(), IsOnLayer(), LAYER_CLEARANCE_START, LAYER_LOCKED_ITEM_SHADOW, LAYER_VIA_COPPER_START, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_NETNAMES, LayerPair(), m_viaType, MAX_CU_LAYERS, and Padstack().

◆ ViewGetLOD()

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

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

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

Parameters

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

Returns: the level of detail. 0 always shows the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented from PCB_TRACK.

Definition at line 1670 of file pcb_track.cpp.

References LSET::AllLayersMask(), B_Cu, LSET::BackTechMask(), end, F_Cu, FlashLayer(), LSET::FrontTechMask(), BOARD_ITEM::GetBoard(), GetDrillValue(), BOARD::GetEnabledLayers(), KIGFX::RENDER_SETTINGS::GetHighContrast(), GetLayerSet(), KIGFX::VIEW::GetPainter(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), KIGFX::PCB_PAINTER::GetSettings(), GetViaType(), BOARD::GetVisibleLayers(), GetWidth(), IsCopperLayer(), IsCopperLayerLowerThan(), IsHoleLayer(), KIGFX::VIEW::IsLayerVisible(), IsNetnameLayer(), LAYER_VIAS, KIGFX::VIEW_ITEM::LOD_HIDE, KIGFX::VIEW_ITEM::LOD_SHOW, KIGFX::VIEW_ITEM::lodScaleForThreshold(), m_viaType, EDA_IU_SCALE::mmToIU(), Padstack(), pcbIUScale, LSET::PhysicalLayersMask(), and ToLAYER_ID().

◆ viewPrivData()

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

inlineinherited

Definition at line 155 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::draw(), KIGFX::VIEW::HasItem(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsHiddenOnOverlay(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

◆ Visit()

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

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 aScanTypes, and may use IterateForward() to do so on lists of such data.

Parameters

inspector	An INSPECTOR instance to use in the inspection.
testData	Arbitrary data used by the inspector.
aScanTypes	Which KICAD_T types are of interest and the order in which they should be processed.

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

Reimplemented from EDA_ITEM.

Definition at line 895 of file pcb_track.cpp.

References EDA_ITEM::Type().

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 139 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by SCH_SELECTION_TOOL::selectMultiple().

Member Data Documentation

◆ LOD_HIDE

constexpr double KIGFX::VIEW_ITEM::LOD_HIDE = std::numeric_limits<double>::max()

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to hide the item unconditionally.

Definition at line 174 of file view_item.h.

Referenced by KIGFX::VIEW_ITEM::lodScaleForThreshold(), KIGFX::VIEW_GROUP::ViewDraw(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), ViewGetLOD(), and ZONE::ViewGetLOD().

◆ LOD_SHOW

constexpr double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

staticconstexprprotectedinherited

Return this constant from ViewGetLOD() to show the item unconditionally.

Definition at line 179 of file view_item.h.

Referenced by KIGFX::VIEW_ITEM::lodScaleForThreshold(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), GERBER_DRAW_ITEM::ViewGetLOD(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), ViewGetLOD(), and ZONE::ViewGetLOD().

◆ m_End

VECTOR2I PCB_TRACK::m_End

protectedinherited

Line end point.

Definition at line 304 of file pcb_track.h.

Referenced by PCB_TRACK::ApproxCollinear(), PCB_TRACK::Flip(), PCB_ARC::Flip(), Flip(), PCB_ARC::GetAngle(), PCB_ARC::GetArcAngleEnd(), PCB_TRACK::GetBoundingBox(), PCB_TRACK::GetEffectiveShape(), PCB_TRACK::GetEnd(), PCB_TRACK::GetEndPoint(), PCB_TRACK::GetEndX(), PCB_TRACK::GetEndY(), PCB_TRACK::GetFocusPosition(), PCB_TRACK::GetLength(), PCB_TRACK::GetMsgPanelInfoBase_Common(), PCB_ARC::GetPosition(), PCB_ARC::GetRadius(), PCB_TRACK::HitTest(), PCB_ARC::IsCCW(), PCB_TRACK::IsNull(), PCB_TRACK::IsPointOnEnds(), PCB_TRACK::Mirror(), PCB_ARC::Mirror(), PCB_TRACK::Move(), PCB_ARC::Move(), operator=(), PCB_ARC::operator==(), PCB_TRACK::operator==(), operator==(), PCB_ARC::PCB_ARC(), PCB_TRACK::Rotate(), PCB_ARC::Rotate(), PCB_TRACK::SetEnd(), PCB_TRACK::SetEndX(), PCB_TRACK::SetEndY(), SetPosition(), PCB_TRACK::Similarity(), PCB_ARC::Similarity(), Similarity(), and PCB_TRACK::TransformShapeToPolygon().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 513 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), SCH_PIN::GetBoundingBox(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::GetTempFlags(), EDA_ITEM::HasFlag(), SCH_FIELD::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_SHAPE::HitTest(), SCH_SYMBOL::HitTest(), SCH_TEXT::HitTest(), SCH_PIN::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsSelected(), EDA_ITEM::IsShownAsBitmap(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), EDA_ITEM::operator=(), PCB_SHAPE::operator==(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), PCB_SHAPE::Similarity(), LIB_SYMBOL::Similarity(), PCB_SHAPE::swapData(), PCB_REFERENCE_IMAGE::swapData(), SCH_ITEM::SwapFlags(), SCH_PIN::ViewBBox(), and EDA_ITEM::XorFlags().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 204 of file view_item.h.

Referenced by KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 516 of file eda_item.h.

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

◆ m_group

EDA_GROUP* EDA_ITEM::m_group

protectedinherited

The group this item belongs to.

Definition at line 515 of file eda_item.h.

Referenced by EDA_ITEM::GetParentGroup(), SCH_LINE::SCH_LINE(), EDA_ITEM::SetParentGroup(), and EDA_ITEM::~EDA_ITEM().

◆ m_hasSolderMask

bool PCB_TRACK::m_hasSolderMask

protectedinherited

Definition at line 306 of file pcb_track.h.

Referenced by PCB_TRACK::GetLayerSet(), PCB_TRACK::HasSolderMask(), PCB_TRACK::IsOnLayer(), PCB_ARC::operator==(), PCB_TRACK::operator==(), PCB_TRACK::PCB_TRACK(), PCB_TRACK::SetHasSolderMask(), PCB_TRACK::Similarity(), PCB_ARC::Similarity(), and PCB_TRACK::ViewGetLayers().

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 202 of file view_item.h.

◆ m_isFree

bool PCB_VIA::m_isFree

private

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

Definition at line 734 of file pcb_track.h.

Referenced by GetIsFree(), operator=(), PCB_VIA(), and SetIsFree().

◆ m_isKnockout

bool BOARD_ITEM::m_isKnockout

protectedinherited

Definition at line 446 of file board_item.h.

Referenced by BOARD_ITEM::IsKnockout(), PCB_SHAPE::operator==(), BOARD_ITEM::SetIsKnockout(), PCB_SHAPE::Similarity(), PCB_SHAPE::swapData(), and PCB_REFERENCE_IMAGE::swapData().

◆ m_isLocked

bool BOARD_ITEM::m_isLocked

protectedinherited

Definition at line 448 of file board_item.h.

Referenced by BOARD_ITEM::IsLocked(), PCB_SHAPE::operator==(), BOARD_ITEM::SetLocked(), PCB_SHAPE::Similarity(), PCB_SHAPE::swapData(), PCB_TABLE::swapData(), and PCB_REFERENCE_IMAGE::swapData().

◆ m_isRollover

bool EDA_ITEM::m_isRollover

protectedinherited

Definition at line 517 of file eda_item.h.

Referenced by EDA_ITEM::IsRollover(), and EDA_ITEM::SetIsRollover().

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 201 of file view_item.h.

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 445 of file board_item.h.

Referenced by FOOTPRINT::FOOTPRINT(), GetDrillConstraint(), BOARD_ITEM::GetLayer(), PCB_SHAPE::GetLayer(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetLayerSet(), PCB_SHAPE::GetLayerSet(), PCB_TRACK::GetLayerSet(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PAD::GetPrincipalLayer(), PCB_TRACK::GetWidthConstraint(), GetWidthConstraint(), BOARD_ITEM::IsOnLayer(), PCB_SHAPE::IsOnLayer(), PCB_TRACK::IsOnLayer(), BOARD_ITEM::IsSideSpecific(), PCB_SHAPE::IsType(), PCB_ARC::operator==(), PCB_REFERENCE_IMAGE::operator==(), PCB_SHAPE::operator==(), PCB_TARGET::operator==(), PCB_TRACK::operator==(), operator==(), PCB_DIMENSION_BASE::PCB_DIMENSION_BASE(), PCB_TARGET::PCB_TARGET(), PCB_TUNING_PATTERN::recoverBaseline(), PCB_MARKER::SerializeToString(), BOARD_ITEM::SetLayer(), PCB_GENERATOR::SetLayer(), PCB_REFERENCE_IMAGE::Similarity(), PCB_TRACK::Similarity(), PCB_ARC::Similarity(), Similarity(), PCB_SHAPE::swapData(), PCB_TABLE::swapData(), PCB_REFERENCE_IMAGE::swapData(), BOARD_ITEM::ViewGetLayers(), FOOTPRINT::ViewGetLayers(), PCB_REFERENCE_IMAGE::ViewGetLayers(), PCB_SHAPE::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), FOOTPRINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), and PCB_TRACK::ViewGetLOD().

◆ m_localRatsnestVisible

bool BOARD_CONNECTED_ITEM::m_localRatsnestVisible

privateinherited

Definition at line 230 of file board_connected_item.h.

Referenced by BOARD_CONNECTED_ITEM::BOARD_CONNECTED_ITEM(), BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible(), and BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible().

◆ m_netinfo

NETINFO_ITEM* BOARD_CONNECTED_ITEM::m_netinfo

protectedinherited

Store all information about the net that item belongs to.

Definition at line 223 of file board_connected_item.h.

Referenced by BOARD_CONNECTED_ITEM::GetDisplayNetname(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), BOARD_CONNECTED_ITEM::GetShortNetname(), ZONE::InitDataFromSrcInCopyCtor(), PCB_SHAPE::operator==(), BOARD_CONNECTED_ITEM::SetNet(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_SHAPE::Similarity(), and PCB_SHAPE::swapData().

◆ m_padStack

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct).

Definition at line 514 of file eda_item.h.

Referenced by SCH_FIELD::DoHypertextAction(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetDefaultLayer(), SCH_FIELD::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), BOARD_ITEM::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), EDA_ITEM::operator=(), PAD::operator==(), PAD::PAD(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_FIELD::Replace(), SCH_LABEL_BASE::ResolveTextVar(), SCH_FIELD::SCH_FIELD(), SCH_SYMBOL::SCH_SYMBOL(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), PAD::Similarity(), PCB_SHAPE::swapData(), PCB_REFERENCE_IMAGE::swapData(), and DRC_TEST_PROVIDER_CREEPAGE::testCreepage().

◆ m_solderMaskMargin

std::optional<int> PCB_TRACK::m_solderMaskMargin

protectedinherited

Definition at line 307 of file pcb_track.h.

Referenced by PCB_TRACK::GetLocalSolderMaskMargin(), PCB_TRACK::GetSolderMaskExpansion(), PCB_ARC::operator==(), PCB_TRACK::operator==(), PCB_TRACK::SetLocalSolderMaskMargin(), PCB_TRACK::Similarity(), and PCB_ARC::Similarity().

◆ m_Start

VECTOR2I PCB_TRACK::m_Start

protectedinherited

Line start point.

Definition at line 303 of file pcb_track.h.

Referenced by PCB_TRACK::ApproxCollinear(), PCB_TRACK::Flip(), PCB_ARC::Flip(), Flip(), PCB_ARC::GetAngle(), PCB_ARC::GetArcAngleStart(), PCB_TRACK::GetBoundingBox(), GetBoundingBox(), GetEffectiveHoleShape(), PCB_TRACK::GetEffectiveShape(), GetEffectiveShape(), PCB_TRACK::GetEndPoint(), PCB_TRACK::GetFocusPosition(), PCB_TRACK::GetLength(), PCB_TRACK::GetMsgPanelInfoBase_Common(), PCB_TRACK::GetPosition(), PCB_ARC::GetPosition(), GetPosition(), PCB_ARC::GetRadius(), PCB_TRACK::GetStart(), PCB_TRACK::GetStartX(), PCB_TRACK::GetStartY(), PCB_TRACK::HitTest(), HitTest(), PCB_ARC::IsCCW(), PCB_TRACK::IsNull(), PCB_TRACK::IsPointOnEnds(), PCB_TRACK::Mirror(), PCB_ARC::Mirror(), PCB_TRACK::Move(), PCB_ARC::Move(), operator=(), PCB_ARC::operator==(), PCB_TRACK::operator==(), operator==(), PCB_ARC::PCB_ARC(), PCB_TRACK::Rotate(), PCB_ARC::Rotate(), SetPosition(), PCB_TRACK::SetPosition(), PCB_ARC::SetPosition(), PCB_TRACK::SetStart(), PCB_TRACK::SetStartX(), PCB_TRACK::SetStartY(), PCB_TRACK::Similarity(), PCB_ARC::Similarity(), Similarity(), and PCB_TRACK::TransformShapeToPolygon().

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

See comment near SetType() regarding virtual functions.

Definition at line 510 of file eda_item.h.

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

◆ m_teardropParams

TEARDROP_PARAMETERS BOARD_CONNECTED_ITEM::m_teardropParams

protectedinherited

Not all BOARD_CONNECTED_ITEMs support teardrops, but we want those that do to share a single section in the property inspector.

Definition at line 227 of file board_connected_item.h.

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 502 of file eda_item.h.

◆ m_viaType

VIATYPE PCB_VIA::m_viaType

private

through, blind/buried or micro

Definition at line 730 of file pcb_track.h.

Referenced by GetViaType(), HasDrilledHole(), IsType(), operator=(), operator==(), SetViaType(), Similarity(), ViewGetLayers(), and ViewGetLOD().

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 203 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::Remove(), KIGFX::VIEW::updateBbox(), KIGFX::VIEW::updateLayers(), and KIGFX::VIEW_ITEM::~VIEW_ITEM().

◆ m_width

int PCB_TRACK::m_width

privateinherited

Thickness of track (or arc) – no longer the width of a via.

Definition at line 310 of file pcb_track.h.

Referenced by PCB_TRACK::GetBoundingBox(), PCB_TRACK::GetEffectiveShape(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetSolderMaskExpansion(), PCB_TRACK::GetWidth(), PCB_TRACK::HitTest(), PCB_TRACK::IsPointOnEnds(), PCB_TRACK::operator==(), PCB_TRACK::PCB_TRACK(), PCB_TRACK::SetWidth(), PCB_TRACK::Similarity(), PCB_TRACK::TransformShapeToPolygon(), and PCB_TRACK::ViewGetLOD().

◆ m_zoneLayerOverrides

std::map<PCB_LAYER_ID, ZONE_LAYER_OVERRIDE> PCB_VIA::m_zoneLayerOverrides

private

Definition at line 737 of file pcb_track.h.

Referenced by ClearZoneLayerOverrides(), GetZoneLayerOverride(), operator==(), PCB_VIA(), SetZoneLayerOverride(), and Similarity().

◆ m_zoneLayerOverridesMutex

std::mutex PCB_VIA::m_zoneLayerOverridesMutex

private

Definition at line 736 of file pcb_track.h.

Referenced by ClearZoneLayerOverrides(), and SetZoneLayerOverride().

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

Definition at line 178 of file board_item.h.

Referenced by BOARD::GetPosition().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

Constructor & Destructor Documentation

◆ PCB_VIA() [1/2]

◆ PCB_VIA() [2/2]

Member Function Documentation

◆ ApproxCollinear()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ BottomLayer()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearZoneLayerOverrides()

◆ Clone()

◆ ConditionallyFlashed()

◆ CopyFrom()

◆ DeleteStructure()

◆ Deserialize()

◆ Duplicate()

◆ FlashLayer() [1/2]

◆ FlashLayer() [2/2]

◆ Flip()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBackCoveringMode()

◆ GetBackPluggingMode()

◆ GetBackTentingMode()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoundingBox() [1/2]

◆ GetBoundingBox() [2/2]

◆ GetCappingMode()

◆ GetCenter()

◆ GetClass()

◆ GetClearanceOverrides()

◆ GetDelay()

◆ GetDisplayNetname()

◆ GetDrill()

◆ GetDrillConstraint()

◆ GetDrillValue()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveNetClass()

◆ GetEffectiveShape()

◆ GetEmbeddedFiles()

◆ GetEnd()

◆ GetEndPoint()

◆ GetEndX()

◆ GetEndY()

◆ GetFillingMode()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFontMetrics()

◆ GetForcedTransparency()

◆ GetFPRelativePosition()

◆ GetFriendlyName()

◆ GetFrontCoveringMode()

◆ GetFrontPluggingMode()

◆ GetFrontTentingMode()

◆ GetFrontWidth()

◆ GetIsFree()

◆ GetItemDescription()