#include <pcb_track.h>

Inheritance diagram for PCB_VIA:

Public Member Functions
	PCB_VIA (BOARD_ITEM *aParent)

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

VIATYPE	GetViaType () const

void	SetViaType (VIATYPE aViaType)

bool	HasHole () const override

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

bool	IsTented () const override

int	GetSolderMaskExpansion () const

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

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

virtual void	SetLayerSet (LSET aLayers) override

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

void	SetBottomLayer (PCB_LAYER_ID aLayer)

void	SetTopLayer (PCB_LAYER_ID aLayer)

void	LayerPair (PCB_LAYER_ID top_layer, PCB_LAYER_ID bottom_layer) const
	Function LayerPair Return the 2 layers used by the via (the via actually uses all layers between these 2 layers) More...

PCB_LAYER_ID	TopLayer () const

PCB_LAYER_ID	BottomLayer () const

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

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

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

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

wxString	GetClass () const override
	Return the class name. More...

wxString	GetSelectMenuText (UNITS_PROVIDER *aUnitsProvider) const override
	Return the text to display to be used in the selection clarification context menu when multiple items are found at the current cursor position. More...

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

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

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

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

void	Flip (const VECTOR2I &aCentre, bool aFlipLeftRight) override
	Flip this object, i.e. More...

int	GetMinAnnulus (PCB_LAYER_ID aLayer, wxString *aSource) const

void	SetRemoveUnconnected (bool aSet)
	Sets the unconnected removal property. More...

bool	GetRemoveUnconnected () const

void	SetKeepTopBottom (bool aSet)
	Sets whether we keep the top and bottom connections even if they are not connected. More...

bool	GetKeepTopBottom () const

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

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

void	SetDrill (int aDrill)
	Function SetDrill sets the drill value for vias. More...

int	GetDrill () const
	Function GetDrill returns the local drill setting for this PCB_VIA. More...

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

void	SetDrillDefault ()
	Function SetDrillDefault sets the drill value for vias to the default value UNDEFINED_DRILL_DIAMETER. More...

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

void	SetIsFree (bool aFree=true)

bool	IsDrillDefault () const
	Function IsDrillDefault. More...

void	SwapData (BOARD_ITEM *aImage) override
	Swap data between aItem and aImage. More...

std::shared_ptr< 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. More...

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

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

virtual void	Mirror (const VECTOR2I &aCentre, bool aMirrorAroundXAxis)

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

void	SetWidth (int aWidth)

int	GetWidth () const

void	SetEnd (const VECTOR2I &aEnd)

const VECTOR2I &	GetEnd () const

void	SetStart (const VECTOR2I &aStart)

const VECTOR2I &	GetStart () 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) More...

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

virtual double	GetLength () const
	Function GetLength returns the length of the track using the hypotenuse calculation. More...

void	TransformShapeWithClearanceToPolygon (SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
	Function TransformShapeWithClearanceToPolygon Convert the track shape to a closed polygon Used in filling zones calculations Circles (vias) and arcs (ends of tracks) are approximated by segments. More...

EDA_ITEM_FLAGS	IsPointOnEnds (const VECTOR2I &point, int min_dist=0) const
	Function IsPointOnEnds returns STARTPOINT if point if near (dist = min_dist) start point, ENDPOINT if point if near (dist = min_dist) end point,STARTPOINT\|ENDPOINT if point if near (dist = min_dist) both ends, or 0 if none of the above. More...

bool	IsNull () const
	Function IsNull returns true if segment length is zero. More...

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

bool	ApproxCollinear (const PCB_TRACK &aTrack)

int	GetLocalClearance (wxString *aSource) const override
	Function GetLocalClearance returns any local clearance overrides set in the "classic" (ie: pre-rule) system. More...

MINOPTMAX< int >	GetWidthConstraint (wxString *aSource) const

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

bool	IsOnCopperLayer () const override

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

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

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

int	GetNetCode () const

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

void	SetNetCode (int aNetCode)

wxString	GetNetname () const

wxString	GetNetnameMsg () const

wxString	GetShortNetname () const

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

virtual int	GetLocalClearanceOverrides (wxString *aSource) const
	Return any local clearance overrides set in the "classic" (ie: pre-rule) system. More...

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

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

void	SetLocalRatsnestVisible (bool aVisible)

bool	GetLocalRatsnestVisible () const

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

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

void	SetX (int aX)

void	SetY (int aY)

BOARD_ITEM_CONTAINER *	GetParent () const

BOARD_ITEM_CONTAINER *	GetParentFootprint () const

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

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

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

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

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

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)

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

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

virtual BOARD *	GetBoard ()

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

KICAD_T	Type () const
	Returns the type of object. More...

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsDragging () const

bool	IsWireImage () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsResized () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetWireImage ()

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

void	ClearTempFlags ()

void	ClearEditFlags ()

virtual bool	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. More...

bool	IsForceVisible () const

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

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

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

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

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

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

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

wxAny	Get (PROPERTY_BASE *aProperty) 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. More...

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

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

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

Public Attributes
VECTOR2I	m_LastNetnamePosition

const KIID	m_Uuid

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

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

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

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

Protected Attributes
int	m_Width
	Thickness of track, or via diameter. More...

VECTOR2I	m_Start
	Line start point. More...

VECTOR2I	m_End
	Line end point. More...

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

PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_status

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

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

Private Attributes
PCB_LAYER_ID	m_bottomLayer
	The bottom layer of the via (the top layer is in m_layer) More...

VIATYPE	m_viaType
	through, blind/buried or micro More...

int	m_drill
	for vias: via drill (- 1 for default value) More...

bool	m_removeUnconnectedLayer
	Remove unconnected copper on a via. More...

bool	m_keepTopBottomLayer
	Keep the top and bottom annular rings. More...

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

bool	m_localRatsnestVisible

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

VIEW_ITEM_DATA *	m_viewPrivData

Detailed Description

Definition at line 323 of file pcb_track.h.

Constructor & Destructor Documentation

◆ PCB_VIA()

PCB_VIA::PCB_VIA ( BOARD_ITEM * aParent )

Definition at line 80 of file pcb_track.cpp.

 :
 PCB_TRACK( aParent, PCB_VIA_T )
{
 SetViaType( VIATYPE::THROUGH );
 m_bottomLayer = B_Cu;
 SetDrillDefault();
 m_removeUnconnectedLayer = false;
 m_keepTopBottomLayer = true;
 m_isFree = false;
}

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

Referenced by Clone().

Member Function Documentation

◆ ApproxCollinear()

bool PCB_TRACK::ApproxCollinear ( const PCB_TRACK & aTrack )

inherited

Definition at line 121 of file pcb_track.cpp.

{
 SEG a( m_Start, m_End );
 SEG b( aTrack.GetStart(), aTrack.GetEnd() );
 return a.ApproxCollinear( b );
}

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

◆ BottomLayer()

PCB_LAYER_ID PCB_VIA::BottomLayer ( ) const

Definition at line 563 of file pcb_track.cpp.

{
 return m_bottomLayer;
}

References m_bottomLayer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), 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 328 of file pcb_track.h.

 {
 return aItem && PCB_VIA_T == aItem->Type();
 }

References PCB_VIA_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 122 of file eda_item.h.

122{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:143

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:66

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 160 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

Referenced by BOARD::Add(), FOOTPRINT::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 143 of file eda_item.h.

143{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:498

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), DRC_TEST_PROVIDER_COURTYARD_CLEARANCE_ON_MOVE::Init(), EE_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 121 of file eda_item.h.

121{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:48

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 155 of file eda_item.h.

 {
 ClearFlags( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT | DO_NOT_DRAW );
 }

References CANDIDATE, EDA_ITEM::ClearFlags(), DO_NOT_DRAW, IS_LINKED, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

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

◆ Clone()

EDA_ITEM * 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 92 of file pcb_track.cpp.

{
 return new PCB_VIA( *this );
}

References PCB_VIA().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 144 of file board_item.cpp.

{
 BOARD_ITEM_CONTAINER* parent = GetParent();
 
 if( parent )
 parent->Remove( this );
 
 delete this;
}

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

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

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 160 of file board_item.cpp.

{
 BOARD_ITEM* dupe = static_cast<BOARD_ITEM*>( Clone() );
 const_cast<KIID&>( dupe->m_Uuid ) = KIID();
 
 if( dupe->GetParentGroup() )
 dupe->GetParentGroup()->AddItem( dupe );
 
 return static_cast<BOARD_ITEM*>( dupe );
}

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

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

◆ FlashLayer() [1/2]

bool PCB_VIA::FlashLayer ( int aLayer ) const

Checks 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 594 of file pcb_track.cpp.

{
 // Return the "normal" shape if the caller doesn't specify a particular layer
 if( aLayer == UNDEFINED_LAYER )
 return true;
 
 const BOARD* board = GetBoard();
 
 if( !board )
 return true;
 
 if( !IsOnLayer( static_cast<PCB_LAYER_ID>( aLayer ) ) )
 return false;
 
 if( !m_removeUnconnectedLayer )
 return true;
 
 if( m_keepTopBottomLayer && ( aLayer == m_layer || aLayer == m_bottomLayer ) )
 return true;
 
 // Must be static to keep from raising its ugly head in performance profiles
 static std::initializer_list<KICAD_T> connectedTypes = { PCB_TRACE_T, PCB_ARC_T, PCB_VIA_T,
 PCB_PAD_T };
 
 // Do not check zones. Doing so results in race conditions when the via collides with
 // two different zones of different priorities.
 // See https://gitlab.com/kicad/code/kicad/-/issues/11299.
 
 return board->GetConnectivity()->IsConnectedOnLayer( this, aLayer, connectedTypes, true );
}

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

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

◆ FlashLayer() [2/2]

bool PCB_VIA::FlashLayer ( LSET aLayers ) const

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

Parameters

aLayers 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 582 of file pcb_track.cpp.

{
 for( auto layer : aLayers.Seq() )
 {
 if( FlashLayer( layer ) )
 return true;
 }
 
 return false;
}

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

◆ Flip()

void PCB_VIA::Flip	(	const VECTOR2I &	aCentre,
		bool	aFlipLeftRight
	)

overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters

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

Reimplemented from PCB_TRACK.

Definition at line 378 of file pcb_track.cpp.

{
 if( aFlipLeftRight )
 {
 m_Start.x = aCentre.x - ( m_Start.x - aCentre.x );
 m_End.x = aCentre.x - ( m_End.x - aCentre.x );
 }
 else
 {
 m_Start.y = aCentre.y - ( m_Start.y - aCentre.y );
 m_End.y = aCentre.y - ( m_End.y - aCentre.y );
 }
 
 if( GetViaType() != VIATYPE::THROUGH )
 {
 int copperLayerCount = GetBoard()->GetCopperLayerCount();
 PCB_LAYER_ID top_layer;
 PCB_LAYER_ID bottom_layer;
 LayerPair( &top_layer, &bottom_layer );
 top_layer = FlipLayer( top_layer, copperLayerCount );
 bottom_layer = FlipLayer( bottom_layer, copperLayerCount );
 SetLayerPair( top_layer, bottom_layer );
 }
}

References FlipLayer(), BOARD_ITEM::GetBoard(), BOARD::GetCopperLayerCount(), GetViaType(), LayerPair(), PCB_TRACK::m_End, PCB_TRACK::m_Start, SetLayerPair(), THROUGH, 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 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 std::optional<T> ret;
 
 if( prop )
 {
 const void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 ret = prop->get<T>( object );
 }
 
 return ret;
 }

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

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

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

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( !object )
 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
 
 return aProperty->get<T>( object );
 }

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

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 51 of file board_item.cpp.

{
 if( Type() == PCB_T )
 return static_cast<BOARD*>( this );
 
 BOARD_ITEM* parent = GetParent();
 
 if( parent )
 return parent->GetBoard();
 
 return nullptr;
}

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

{
 if( Type() == PCB_T )
 return static_cast<const BOARD*>( this );
 
 BOARD_ITEM* parent = GetParent();
 
 if( parent )
 return parent->GetBoard();
 
 return nullptr;
}

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

Referenced by ZONE_FILLER::addHoleKnockout(), BOARD_ADAPTER::addShape(), FOOTPRINT::BuildCourtyardCaches(), PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), ZONE::CacheBoundingBox(), collidesWithArea(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), enclosedByAreaFunc(), existsOnLayerFunc(), PAD::FlashLayer(), FlashLayer(), FP_SHAPE::Flip(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_SHAPE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), Flip(), ZONE::Flip(), fromToFunc(), BOARD_ITEM::GetBoard(), PCB_EXPR_CONTEXT::GetBoard(), NETINFO_ITEM::GetBoundingBox(), ZONE::GetBoundingBox(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), FOOTPRINT::GetCourtyard(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), GetEffectiveShape(), getFieldFunc(), ZONE::GetInteractingZones(), BOARD_ITEM::GetLayerName(), GetMinAnnulus(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetOwnClearance(), ZONE::GetSelectMenuText(), PCB_MARKER::GetSeverity(), FP_TEXT::GetShownText(), FP_TEXTBOX::GetShownText(), PAD::GetSolderMaskExpansion(), GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), PCB_TRACK::GetWidthConstraint(), inDiffPairFunc(), ROUTER_TOOL::Init(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), BOARD_ITEM::IsLocked(), IsTented(), BOARD_ITEM::layerMaskDescribe(), layerMaskDescribe(), PAD::MergePrimitivesAsPolygon(), DIALOG_TEXTBOX_PROPERTIES::onBorderChecked(), EAGLE_PLUGIN::packageWire(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), BOARD_CONNECTED_ITEM::SetNetCode(), TEARDROP_DIALOG::TEARDROP_DIALOG(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), ZONE::TransformSmoothedOutlineToPolygon(), BOARD::UpdateRatsnestExclusions(), FOOTPRINT::ViewBBox(), PCB_TRACK::ViewBBox(), PAD::ViewGetLOD(), PCB_BITMAP::ViewGetLOD(), and ViewGetLOD().

◆ GetBoundingBox()

const BOX2I PCB_TRACK::GetBoundingBox ( ) const

overridevirtualinherited

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

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

Reimplemented from EDA_ITEM.

Definition at line 232 of file pcb_track.cpp.

{
 // end of track is round, this is its radius, rounded up
 int radius = ( m_Width + 1 ) / 2;
 int ymax, xmax, ymin, xmin;
 
 if( Type() == PCB_VIA_T )
 {
 ymax = m_Start.y;
 xmax = m_Start.x;
 
 ymin = m_Start.y;
 xmin = m_Start.x;
 }
 else if( Type() == PCB_ARC_T )
 {
 std::shared_ptr<SHAPE> arc = GetEffectiveShape();
 BOX2I bbox = arc->BBox();
 
 xmin = bbox.GetLeft();
 xmax = bbox.GetRight();
 ymin = bbox.GetTop();
 ymax = bbox.GetBottom();
 }
 else
 {
 ymax = std::max( m_Start.y, m_End.y );
 xmax = std::max( m_Start.x, m_End.x );
 
 ymin = std::min( m_Start.y, m_End.y );
 xmin = std::min( m_Start.x, m_End.x );
 }
 
 ymax += radius;
 xmax += radius;
 
 ymin -= radius;
 xmin -= radius;
 
 // return a rectangle which is [pos,dim) in nature. therefore the +1
 BOX2I ret( VECTOR2I( xmin, ymin ), VECTOR2I( xmax - xmin + 1, ymax - ymin + 1 ) );
 
 return ret;
}

References BOX2< Vec >::GetBottom(), PCB_TRACK::GetEffectiveShape(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), PCB_TRACK::m_End, PCB_TRACK::m_Start, PCB_TRACK::m_Width, PCB_ARC_T, PCB_VIA_T, EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DRAWING_TOOL::DrawVia(), and PCB_TRACK::ViewBBox().

◆ 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 PAD, PCB_MARKER, PCB_SHAPE, and PCB_ARC.

Definition at line 83 of file board_item.h.

 {
 return GetBoundingBox().GetCenter();
 }

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

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

◆ GetClass()

wxString PCB_VIA::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from PCB_TRACK.

Definition at line 409 of file pcb_track.h.

 {
 return wxT( "PCB_VIA" );
 }

◆ GetDrill()

int PCB_VIA::GetDrill ( ) const

inline

Function GetDrill returns the local drill setting for this PCB_VIA.

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

Definition at line 471 of file pcb_track.h.

471{ return m_drill; }

PCB_VIA::m_drill

int m_drill

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

Definition: pcb_track.h:516

References m_drill.

Referenced by DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetDrillValue()

int PCB_VIA::GetDrillValue ( ) const

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

Returns: real drill_value

Definition at line 185 of file pcb_track.cpp.

{
 if( m_drill > 0 ) // Use the specific value.
 return m_drill;
 
 // Use the default value from the Netclass
 NETCLASS* netclass = GetEffectiveNetClass();
 
 if( GetViaType() == VIATYPE::MICROVIA )
 return netclass->GetuViaDrill();
 
 return netclass->GetViaDrill();
}

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

Referenced by DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PCB_PAINTER::getDrillSize(), GetMsgPanelInfo(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), RENDER_3D_RAYTRACE::insertHole(), PNS_KICAD_IFACE_BASE::syncVia(), TRACK_VIA_DESC::TRACK_VIA_DESC(), VIAPAD::VIAPAD(), and ViaSort().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 147 of file eda_item.h.

 {
 constexpr int mask = ( IS_NEW | IS_PASTED | IS_MOVING | IS_RESIZING | IS_DRAGGING
 | IS_CHANGED | IS_WIRE_IMAGE | STRUCT_DELETED );
 
 return m_flags & mask;
 }

References IS_CHANGED, IS_DRAGGING, IS_MOVING, IS_NEW, IS_PASTED, IS_RESIZING, IS_WIRE_IMAGE, 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 421 of file pcb_track.cpp.

{
 return std::make_shared<SHAPE_SEGMENT>( SEG( m_Start, m_Start ), m_drill );
}

References m_drill, and PCB_TRACK::m_Start.

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

{
 if( m_netinfo && m_netinfo->GetNetClass() )
 return m_netinfo->GetNetClass();
 else
 return GetBoard()->GetDesignSettings().m_NetSettings->m_DefaultNetClass.get();
}

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

Referenced by GetDrillValue(), BOARD_INSPECTION_TOOL::getItemDescription(), PAD::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetClassName(), PCB_EXPR_NETCLASS_REF::GetValue(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), 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.

Reimplemented from PCB_TRACK.

Definition at line 1146 of file pcb_track.cpp.

{
 if( aFlash == FLASHING::ALWAYS_FLASHED
 || ( aFlash == FLASHING::DEFAULT && FlashLayer( aLayer ) ) )
 {
 return std::make_shared<SHAPE_CIRCLE>( m_Start, m_Width / 2 );
 }
 else
 {
 int radius = GetDrillValue() / 2;
 
 if( GetBoard() )
 radius += GetBoard()->GetDesignSettings().GetHolePlatingThickness();
 
 return std::make_shared<SHAPE_CIRCLE>( m_Start, radius );
 }
}

References ALWAYS_FLASHED, DEFAULT, BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetHolePlatingThickness(), PCB_TRACK::m_Start, and PCB_TRACK::m_Width.

Referenced by DRAWING_TOOL::DrawVia().

◆ GetEnd()

const VECTOR2I & PCB_TRACK::GetEnd ( ) const

inlineinherited

Definition at line 108 of file pcb_track.h.

108{ return m_End; }

References PCB_TRACK::m_End.

Referenced by CN_LIST::Add(), TEARDROP_MANAGER::addTeardropsOnTracks(), PCB_TRACK::ApproxCollinear(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createTrack(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PCB_PLUGIN::format(), PCB_ARC::GetEffectiveShape(), getMinDist(), CONVERT_TOOL::getStartEndPoints(), PCB_TRACK::HitTest(), PCB_ARC::HitTest(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), ROUTER_TOOL::NeighboringSegmentFilter(), PlotStandardLayer(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), TRACKS_CLEANER::testTrackEndpointIsNode(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PCB_TRACK::TransformShapeWithClearanceToPolygon(), VIAPAD::VIAPAD(), 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 120 of file pcb_track.h.

 {
 if( aEndPoint == ENDPOINT_START )
 return m_Start;
 else
 return m_End;
 }

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

116{ return m_End.x; }

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

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetEndY()

int PCB_TRACK::GetEndY ( ) const

inlineinherited

Definition at line 117 of file pcb_track.h.

117{ return m_End.y; }

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

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 144 of file eda_item.h.

144{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), 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_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ GetFocusPosition()

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.

Definition at line 102 of file pcb_track.h.

102{ return ( m_Start + m_End ) / 2; }

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

◆ GetIsFree()

bool PCB_VIA::GetIsFree ( ) const

inline

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

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

Returns: true if the via is a free via

Definition at line 492 of file pcb_track.h.

492{ return m_isFree; }

References m_isFree.

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

◆ GetKeepTopBottom()

bool PCB_VIA::GetKeepTopBottom ( ) const

inline

Definition at line 443 of file pcb_track.h.

443{ return m_keepTopBottomLayer; }

References m_keepTopBottomLayer.

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in PAD, and ZONE.

Definition at line 167 of file board_item.h.

167{ return m_layer; }

References BOARD_ITEM::m_layer.

Referenced by BOARD::Add(), CN_LIST::Add(), BOARD_ADAPTER::addFootprintShapes(), TEARDROP_MANAGER::addTeardropsOnTracks(), GRAPHICS_CLEANER::areEquivalent(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), AR_AUTOPLACER::buildFpAreas(), PNS::ITEM::collideSimple(), TEARDROP_MANAGER::ComputePointsOnPadVia(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), TEARDROP_MANAGER::createTeardrop(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_GRAPHIC_ITEM_PROPERTIES::DIALOG_GRAPHIC_ITEM_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), PCB_EDIT_FRAME::ExchangeFootprint(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), TEARDROP_MANAGER::findTouchingTrack(), FOOTPRINT::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_SHAPE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), PCB_PLUGIN::FootprintSave(), FootprintWriteShape(), PCB_PLUGIN::format(), FP_TEXT::FP_TEXT(), DSN::SPECCTRA_DB::FromSESSION(), AR_AUTOPLACER::genModuleOnRoutingMatrix(), FOOTPRINT::GetBoundingBox(), PAD::GetLayer(), ZONE::GetLayer(), getMatchingTextItem(), PCB_TRACK::GetMsgPanelInfo(), GetMsgPanelInfo(), AR_AUTOPLACER::getOptimalFPPlacement(), BOARD::GetPad(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), idf_export_footprint(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), FOOTPRINT::IsFlipped(), PAD::IsFlipped(), BOARD_ITEM::IsOnCopperLayer(), FP_SHAPE::IsParentFlipped(), FP_TEXT::IsParentFlipped(), TEARDROP_MANAGER::isViaAndTrackInSameZone(), itemIsIncludedByFilter(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), FABMASTER::loadFootprints(), FABMASTER::loadOutline(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_TEXTBOX_PROPERTIES::onBorderChecked(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), EAGLE_PLUGIN::packagePad(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbGraphicItem(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), DRC_ENGINE::ProcessAssertions(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PCB_CONTROL::pruneItemLayers(), PAD_TOOL::RecombinePad(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::Selectable(), shapesNeedUpdate(), GLOBAL_EDIT_TOOL::swapBoardItem(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::SyncWorld(), AR_AUTOPLACER::testFootprintOnBoard(), DRC_TEST_PROVIDER_MISC::testTextVars(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), textsNeedUpdate(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), BOARD_ADAPTER::transformFPShapesToPolygon(), FOOTPRINT::TransformFPShapesWithClearanceToPolygon(), PCB_CONTROL::UpdateMessagePanel(), FP_TEXT::ViewGetLayers(), FP_TEXTBOX::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), FP_TEXT::ViewGetLOD(), FP_TEXTBOX::ViewGetLOD(), FP_ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

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

Returns: the layer name associated with this item.

Definition at line 88 of file board_item.cpp.

{
 const BOARD* board = GetBoard();
 
 if( board )
 return board->GetLayerName( m_layer );
 
 // If no parent, return standard name
 return BOARD::GetStandardLayerName( m_layer );
}

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

Referenced by FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), FP_SHAPE::GetSelectMenuText(), PCB_DIMENSION_BASE::GetSelectMenuText(), PCB_SHAPE::GetSelectMenuText(), PCB_TEXT::GetSelectMenuText(), PCB_TEXTBOX::GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), and FOOTPRINT::ResolveTextVar().

◆ GetLayerSet()

LSET PCB_VIA::GetLayerSet ( ) const

overridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 471 of file pcb_track.cpp.

{
 LSET layermask;
 
 if( GetViaType() == VIATYPE::THROUGH )
 layermask = LSET::AllCuMask();
 else
 wxASSERT( m_layer <= m_bottomLayer );
 
 // PCB_LAYER_IDs are numbered from front to back, this is top to bottom.
 for( int id = m_layer; id <= m_bottomLayer; ++id )
 layermask.set( id );
 
 if( !IsTented() )
 {
 if( layermask.test( F_Cu ) )
 layermask.set( F_Mask );
 
 if( layermask.test( B_Cu ) )
 layermask.set( B_Mask );
 }
 
 return layermask;
}

References LSET::AllCuMask(), B_Cu, B_Mask, F_Cu, F_Mask, GetViaType(), IsTented(), m_bottomLayer, BOARD_ITEM::m_layer, and THROUGH.

Referenced by TRACKS_CLEANER::cleanup(), DRAWING_TOOL::DrawVia(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), IsOnLayer(), ViaSort(), and ViewGetLOD().

◆ GetLength()

double PCB_TRACK::GetLength ( ) const

virtualinherited

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

Returns: double - the length of the track

Reimplemented in PCB_ARC.

Definition at line 278 of file pcb_track.cpp.

{
 return GetLineLength( m_Start, m_End );
}

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

◆ GetLocalClearance()

int PCB_TRACK::GetLocalClearance ( wxString * aSource ) const

overridevirtualinherited

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

Parameters

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

Returns: int - the clearance in internal units.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 129 of file pcb_track.cpp.

{
 // Not currently implemented
 return 0;
}

◆ GetLocalClearanceOverrides()

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

inlinevirtualinherited

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

Parameters

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

Returns: the clearance in internal units.

Reimplemented in PAD.

Definition at line 142 of file board_connected_item.h.

142{ return 0; }

Referenced by DRC_ENGINE::EvalRules().

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const

inlineinherited

Definition at line 171 of file board_connected_item.h.

 {
 return m_localRatsnestVisible;
 }

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint().

◆ 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 115 of file pcb_track.cpp.

{
 return BITMAPS::via;
}

References via.

◆ GetMinAnnulus()

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

Definition at line 154 of file pcb_track.cpp.

{
 if( !FlashLayer( aLayer ) )
 {
 if( aSource )
 *aSource = _( "removed annular ring" );
 
 return 0;
 }
 
 DRC_CONSTRAINT constraint;
 
 if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
 {
 BOARD_DESIGN_SETTINGS& bds = GetBoard()->GetDesignSettings();
 
 constraint = bds.m_DRCEngine->EvalRules( ANNULAR_WIDTH_CONSTRAINT, this, nullptr, aLayer );
 }
 
 if( constraint.Value().HasMin() )
 {
 if( aSource )
 *aSource = constraint.GetName();
 
 return constraint.Value().Min();
 }
 
 return 0;
}

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

aList is the list to populate.

Reimplemented from PCB_TRACK.

Definition at line 879 of file pcb_track.cpp.

{
 wxString msg;
 
 switch( GetViaType() )
 {
 case VIATYPE::MICROVIA: msg = _( "Micro Via" ); break;
 case VIATYPE::BLIND_BURIED: msg = _( "Blind/Buried Via" ); break;
 case VIATYPE::THROUGH: msg = _( "Through Via" ); break;
 default: msg = _( "Via" ); break;
 }
 
 aList.emplace_back( _( "Type" ), msg );
 
 GetMsgPanelInfoBase_Common( aFrame, aList );
 
 aList.emplace_back( _( "Layer" ), layerMaskDescribe() );
 aList.emplace_back( _( "Diameter" ), aFrame->MessageTextFromValue( m_Width ) );
 aList.emplace_back( _( "Hole" ), aFrame->MessageTextFromValue( GetDrillValue() ) );
 
 wxString source;
 int clearance = GetOwnClearance( GetLayer(), &source );
 
 aList.emplace_back( wxString::Format( _( "Min Clearance: %s" ),
 aFrame->MessageTextFromValue( clearance ) ),
 wxString::Format( _( "(from %s)" ), source ) );
 
 int minAnnulus = GetMinAnnulus( GetLayer(), &source );
 
 aList.emplace_back( wxString::Format( _( "Min Annular Width: %s" ),
 aFrame->MessageTextFromValue( minAnnulus ) ),
 wxString::Format( _( "(from %s)" ), source ) );
}

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

◆ GetMsgPanelInfoBase_Common()

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

protectedinherited

Definition at line 914 of file pcb_track.cpp.

{
 aList.emplace_back( _( "Net" ), UnescapeString( GetNetname() ) );
 
 aList.emplace_back( _( "Resolved Netclass" ),
 UnescapeString( GetEffectiveNetClass()->GetName() ) );
 
#if 0 // Enable for debugging
 if( GetBoard() )
 aList.emplace_back( _( "NetCode" ), wxString::Format( wxT( "%d" ), GetNetCode() ) );
 
 aList.emplace_back( wxT( "Flags" ), wxString::Format( wxT( "0x%08X" ), m_flags ) );
 
 aList.emplace_back( wxT( "Start pos" ), wxString::Format( wxT( "%d %d" ),
 m_Start.x,
 m_Start.y ) );
 aList.emplace_back( wxT( "End pos" ), wxString::Format( wxT( "%d %d" ),
 m_End.x,
 m_End.y ) );
#endif
 
 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME && IsLocked() )
 aList.emplace_back( _( "Status" ), _( "Locked" ) );
}

References _, Format(), 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 75 of file board_connected_item.h.

 {
 return m_netinfo;
 }

References BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), BOARD_EDITOR_CONTROL::RepairBoard(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow().

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

{
 return GetEffectiveNetClass()->GetName();
}

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

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and main().

◆ GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const

inherited

Returns: the net code.

Definition at line 89 of file board_connected_item.cpp.

{
 return m_netinfo ? m_netinfo->GetNetCode() : -1;
}

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

Referenced by ZONE_FILLER::addHatchFillTypeOnZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), ZONE_FILLER::buildCopperItemClearances(), KI_TEST::CheckFpPad(), KI_TEST::CheckFpZone(), connectedItemFilter(), CreateRoutesSection(), TEARDROP_MANAGER::createTeardrop(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), PNS::NODE::FindItemByParent(), TEARDROP_MANAGER::findTouchingTrack(), PCB_PLUGIN::format(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), CONNECTIVITY_DATA::GetConnectedItems(), ZONE::GetInteractingZones(), PCB_TRACK::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), CONNECTIVITY_DATA::GetRatsnestForPad(), BOARD_INSPECTION_TOOL::highlightNet(), DIALOG_PAD_PROPERTIES::initValues(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), CONNECTIVITY_DATA::IsConnectedOnLayer(), ZONE::IsIsland(), ZONE::IsSame(), TEARDROP_MANAGER::isViaAndTrackInSameZone(), ZONE_FILLER::knockoutThermalReliefs(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), AR_AUTOPLACER::nearestPad(), ROUTER_TOOL::NeighboringSegmentFilter(), CN_ITEM::Net(), DIALOG_DRC::OnDRCItemSelected(), PCB_TRACK::cmp_tracks::operator()(), ZONE_SETTINGS::operator<<(), DIALOG_PAD_PROPERTIES::PadTypeSelected(), process(), BOARD_EDITOR_CONTROL::RepairBoard(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), DRC_TEST_PROVIDER_MATCHED_LENGTH::runInternal(), ZONE::SameNet(), PCB_SELECTION_CONDITIONS::sameNetFunc(), SaveCopyOfZones(), PCB_SELECTION_TOOL::selectNet(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), BOARD::TracksInNet(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), PCB_CONTROL::UpdateMessagePanel(), VIAPAD::VIAPAD(), PCB_TRACK::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inherited

Returns: the full netname.

Definition at line 112 of file board_connected_item.cpp.

{
 return m_netinfo ? m_netinfo->GetNetname() : wxString();
}

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

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), PAD::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), ZONE_SEARCH_HANDLER::GetResultCell(), PCB_EXPR_NETNAME_REF::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), CN_CLUSTER::OriginNetName(), BRDITEMS_PLOTTER::PlotFilledAreas(), BRDITEMS_PLOTTER::PlotPad(), 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 118 of file board_connected_item.cpp.

{
 if( !GetBoard() )
 return wxT( "[** NO BOARD DEFINED **]" );
 
 wxString netname = GetNetname();
 
 if( !netname.length() )
 return wxT( "[<no net>]" );
 else if( GetNetCode() < 0 )
 return wxT( "[" ) + UnescapeString( netname ) + wxT( "](" ) + _( "Not Found" ) + wxT( ")" );
 else
 return wxT( "[" ) + UnescapeString( netname ) + wxT( "]" );
}

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

Referenced by PAD::GetSelectMenuText(), PCB_TRACK::GetSelectMenuText(), GetSelectMenuText(), and ZONE::GetSelectMenuText().

◆ GetOwnClearance()

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

virtualinherited

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

Parameters

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

{
 DRC_CONSTRAINT constraint;
 
 if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
 {
 BOARD_DESIGN_SETTINGS& bds = GetBoard()->GetDesignSettings();
 
 constraint = bds.m_DRCEngine->EvalRules( CLEARANCE_CONSTRAINT, this, nullptr, aLayer );
 }
 
 if( constraint.Value().HasMin() )
 {
 if( aSource )
 *aSource = constraint.GetName();
 
 return constraint.Value().Min();
 }
 
 return 0;
}

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 ( void ) const

inlineinherited

Definition at line 150 of file board_item.h.

150{ return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:496

References EDA_ITEM::m_parent.

◆ GetParentFootprint()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 217 of file board_item.cpp.

{
 BOARD_ITEM_CONTAINER* ancestor = GetParent();
 
 while( ancestor && ancestor->Type() == PCB_GROUP_T )
 ancestor = ancestor->GetParent();
 
 return ( ancestor && ancestor->Type() == PCB_FOOTPRINT_T ) ? ancestor : nullptr;
}

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), PNS::ITEM::collideSimple(), CONVERT_TOOL::CreatePolys(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), PCB_SHAPE::GetParentFootprint(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), DRC_ENGINE::IsNetTieExclusion(), LEGACY_PLUGIN::loadMODULE_TEXT(), PAD_TOOL::RecombinePad(), PAD::SameLogicalPadAs(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), and zonesNeedUpdate().

◆ GetParentGroup()

PCB_GROUP * BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 62 of file board_item.h.

62{ return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:322

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), BOARD_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), getTopLevelGroup(), BOARD::GroupLegalOps(), BOARD_ITEM::IsLocked(), memberOfFunc(), BOARD::Move(), PCB_CONTROL::placeBoardItems(), BOARD_COMMIT::Push(), BOARD::Remove(), FOOTPRINT::Remove(), GROUP_TOOL::RemoveFromGroup(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetPosition()

VECTOR2I PCB_VIA::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from PCB_TRACK.

Definition at line 401 of file pcb_track.h.

401{ return m_Start; }

References PCB_TRACK::m_Start.

Referenced by TRACKS_CLEANER::cleanup(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), DRAWING_TOOL::DrawVia(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and VIAPAD::VIAPAD().

◆ GetRemoveUnconnected()

bool PCB_VIA::GetRemoveUnconnected ( ) const

inline

Definition at line 437 of file pcb_track.h.

437{ return m_removeUnconnectedLayer; }

References m_removeUnconnectedLayer.

◆ GetSelectMenuText()

wxString PCB_VIA::GetSelectMenuText ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

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

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

Returns: The menu text string.

Reimplemented from PCB_TRACK.

Definition at line 98 of file pcb_track.cpp.

{
 wxString formatStr;
 
 switch( GetViaType() )
 {
 case VIATYPE::BLIND_BURIED: formatStr = _( "Blind/Buried Via %s on %s" ); break;
 case VIATYPE::MICROVIA: formatStr = _( "Micro Via %s on %s" ); break;
 default: formatStr = _( "Via %s on %s" ); break;
 }
 
 return wxString::Format( formatStr,
 GetNetnameMsg(),
 layerMaskDescribe() );
}

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

◆ GetShortNetname()

wxString BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

Definition at line 134 of file board_connected_item.cpp.

{
 return m_netinfo->GetShortNetname();
}

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

Referenced by KIGFX::PCB_PAINTER::draw(), PAD::IsFreePad(), and PAD::IsNoConnectPad().

◆ GetSolderMaskExpansion()

int PCB_VIA::GetSolderMaskExpansion ( ) const

Definition at line 438 of file pcb_track.cpp.

{
 const BOARD* board = GetBoard();
 
 if( board )
 return board->GetDesignSettings().m_SolderMaskExpansion;
 else
 return 0;
}

References BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), and BOARD_DESIGN_SETTINGS::m_SolderMaskExpansion.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), and 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 265 of file eda_item.h.

265{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

◆ GetStart()

const VECTOR2I & PCB_TRACK::GetStart ( ) const

inlineinherited

Definition at line 111 of file pcb_track.h.

111{ return m_Start; }

References PCB_TRACK::m_Start.

Referenced by CN_LIST::Add(), TEARDROP_MANAGER::addTeardropsOnTracks(), PCB_TRACK::ApproxCollinear(), PCB_GRID_HELPER::computeAnchors(), BOARD_ADAPTER::createTrack(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::Drag(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), PCB_PLUGIN::format(), PCB_ARC::GetEffectiveShape(), getMinDist(), CONVERT_TOOL::getStartEndPoints(), PCB_TRACK::HitTest(), HitTest(), PCB_ARC::HitTest(), RENDER_3D_RAYTRACE::insertHole(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), ROUTER_TOOL::NeighboringSegmentFilter(), PlotStandardLayer(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackAgainstItem(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), TRACKS_CLEANER::testTrackEndpointIsNode(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PCB_TRACK::TransformShapeWithClearanceToPolygon(), VIAPAD::VIAPAD(), and PCB_TRACK::ViewGetLOD().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 126 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 139 of file eda_item.h.

139{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 76 of file board_item.cpp.

{
 wxCHECK( false, STROKE_PARAMS( pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH ) ) );
}

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

Referenced by PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( )

inherited

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

Definition at line 301 of file eda_item.cpp.

{
 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
 
 return wxGetTranslation( typeDescr );
}

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

Referenced by PROPERTIES_PANEL::update().

◆ GetViaType()

VIATYPE PCB_VIA::GetViaType ( ) const

inline

Definition at line 353 of file pcb_track.h.

353{ return m_viaType; }

PCB_VIA::m_viaType

VIATYPE m_viaType

through, blind/buried or micro

Definition: pcb_track.h:514

References m_viaType.

Referenced by TRACKS_CLEANER::cleanup(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), Flip(), GetDrillValue(), GetLayerSet(), GetMsgPanelInfo(), GetSelectMenuText(), RENDER_3D_RAYTRACE::insertHole(), LayerPair(), SanitizeLayers(), PNS_KICAD_IFACE_BASE::syncVia(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and ViewGetLayers().

◆ GetWidth()

int PCB_TRACK::GetWidth ( ) const

inlineinherited

Definition at line 105 of file pcb_track.h.

105{ return m_Width; }

References PCB_TRACK::m_Width.

Referenced by TEARDROP_MANAGER::addTeardropsOnTracks(), TEARDROP_MANAGER::computeTeardropPolygonPoints(), BOARD_ADAPTER::createTrack(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::FilletTracks(), PCB_PLUGIN::format(), PCB_ARC::GetEffectiveShape(), CONVERT_TOOL::getStartEndPoints(), HitTest(), PCB_ARC::HitTest(), HYPERLYNX_PAD_STACK::HYPERLYNX_PAD_STACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), TRACK_VIA_DESC::TRACK_VIA_DESC(), BOARD_EDITOR_CONTROL::TrackWidthInc(), VIAPAD::VIAPAD(), ViaSort(), PCB_TRACK::ViewBBox(), and PCB_TRACK::ViewGetLOD().

◆ GetWidthConstraint()

MINOPTMAX< int > PCB_TRACK::GetWidthConstraint ( wxString * aSource ) const

inherited

Definition at line 136 of file pcb_track.cpp.

{
 DRC_CONSTRAINT constraint;
 
 if( GetBoard() && GetBoard()->GetDesignSettings().m_DRCEngine )
 {
 BOARD_DESIGN_SETTINGS& bds = GetBoard()->GetDesignSettings();
 
 constraint = bds.m_DRCEngine->EvalRules( TRACK_WIDTH_CONSTRAINT, this, nullptr, m_layer );
 }
 
 if( aSource )
 *aSource = constraint.GetName();
 
 return constraint.Value();
}

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

Referenced by PCB_TRACK::GetMsgPanelInfo().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 66 of file board_item.h.

 {
 VECTOR2I p = GetPosition();
 return p.x;
 }

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

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), BOARD_ITEM::SetY(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 72 of file board_item.h.

 {
 VECTOR2I p = GetPosition();
 return p.y;
 }

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

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), BOARD_ITEM::SetX(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 145 of file eda_item.h.

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

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), and EE_TOOL_BASE< T >::saveCopyInUndoList().

◆ HasHole()

bool PCB_VIA::HasHole ( ) const

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 356 of file pcb_track.h.

 {
 return true;
 }

◆ 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 159 of file board_item.h.

159{ return false; }

◆ 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 1036 of file pcb_track.cpp.

{
 BOX2I arect = aRect;
 arect.Inflate( aAccuracy );
 
 BOX2I box( GetStart() );
 box.Inflate( GetWidth() / 2 );
 
 if( aContained )
 return arect.Contains( box );
 else
 return arect.IntersectsCircle( GetStart(), GetWidth() / 2 );
}

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

◆ 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 995 of file pcb_track.cpp.

{
 int max_dist = aAccuracy + ( m_Width / 2 );
 
 // rel_pos is aPosition relative to m_Start (or the center of the via)
 VECTOR2I rel_pos = aPosition - m_Start;
 double dist = (double) rel_pos.x * rel_pos.x + (double) rel_pos.y * rel_pos.y;
 return dist <= (double) max_dist * max_dist;
}

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

110{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), SCH_EDITOR_CONTROL::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 ZONE.

Definition at line 67 of file board_connected_item.h.

 {
 return true;
 }

◆ IsDragging()

bool EDA_ITEM::IsDragging ( ) const

inlineinherited

Definition at line 105 of file eda_item.h.

105{ return m_flags & IS_DRAGGING; }

References IS_DRAGGING, and EDA_ITEM::m_flags.

Referenced by DIALOG_SYMBOL_PROPERTIES::DIALOG_SYMBOL_PROPERTIES().

◆ IsDrillDefault()

bool PCB_VIA::IsDrillDefault ( ) const

inline

Function IsDrillDefault.

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

Definition at line 499 of file pcb_track.h.

499{ return m_drill <= 0; }

References m_drill.

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:73

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 203 of file eda_item.h.

203{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:497

References EDA_ITEM::m_forceVisible.

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

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Definition at line 237 of file board_item.h.

237{ return m_isKnockout; }

BOARD_ITEM::m_isKnockout

bool m_isKnockout

Definition: board_item.h:318

References BOARD_ITEM::m_isKnockout.

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), PCB_TEXT::GetBoundingBox(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotPcbGraphicItem(), and PCB_TEXT::TextHitTest().

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

Reimplemented in FOOTPRINT, and PAD.

Definition at line 65 of file board_item.cpp.

{
 if( GetParentGroup() )
 return GetParentGroup()->IsLocked();
 
 const BOARD* board = GetBoard();
 
 return board && board->GetBoardUse() != BOARD_USE::FPHOLDER && m_isLocked;
}

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_FRAME::SaveSymbolToSchematic(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), and DIALOG_SHEET_PROPERTIES::TransferDataFromWindow().

◆ IsNull()

bool PCB_TRACK::IsNull ( ) const

inlineinherited

Function IsNull returns true if segment length is zero.

Definition at line 171 of file pcb_track.h.

 {
 return ( Type() == PCB_VIA_T ) || ( m_Start == m_End );
 }

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

 {
 return true;
 }

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

Definition at line 449 of file pcb_track.cpp.

{
#if 0
 // Nice and simple, but raises its ugly head in performance profiles....
 return GetLayerSet().test( aLayer );
#endif
 
 if( aLayer >= m_layer && aLayer <= m_bottomLayer )
 return true;
 
 if( !IsTented() )
 {
 if( aLayer == F_Mask )
 return IsOnLayer( F_Cu );
 else if( aLayer == B_Mask )
 return IsOnLayer( B_Cu );
 }
 
 return false;
}

References B_Cu, B_Mask, F_Cu, F_Mask, GetLayerSet(), IsOnLayer(), IsTented(), m_bottomLayer, and BOARD_ITEM::m_layer.

Referenced by FlashLayer(), IsOnLayer(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ IsPointOnEnds()

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

inherited

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

if min_dist < 0: min_dist = track_width/2

Definition at line 200 of file pcb_track.cpp.

{
 EDA_ITEM_FLAGS result = 0;
 
 if( min_dist < 0 )
 min_dist = m_Width / 2;
 
 if( min_dist == 0 )
 {
 if( m_Start == point )
 result |= STARTPOINT;
 
 if( m_End == point )
 result |= ENDPOINT;
 }
 else
 {
 double dist = GetLineLength( m_Start, point );
 
 if( min_dist >= KiROUND( dist ) )
 result |= STARTPOINT;
 
 dist = GetLineLength( m_End, point );
 
 if( min_dist >= KiROUND( dist ) )
 result |= ENDPOINT;
 }
 
 return result;
}

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

Referenced by TEARDROP_MANAGER::addTeardropsOnTracks(), EDIT_TOOL::FilletTracks(), TRACKS_CLEANER::mergeCollinearSegments(), and ROUTER_TOOL::NeighboringSegmentFilter().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 420 of file eda_item.h.

420{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsResized()

bool EDA_ITEM::IsResized ( ) const

inlineinherited

Definition at line 109 of file eda_item.h.

109{ return m_flags & IS_RESIZING; }

References IS_RESIZING, and EDA_ITEM::m_flags.

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

 {
 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
 }

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 175 of file eda_item.h.

175{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:55

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsTented()

bool PCB_VIA::IsTented ( ) const

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 427 of file pcb_track.cpp.

{
 const BOARD* board = GetBoard();
 
 if( board )
 return board->GetTentVias();
 else
 return true;
}

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

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

 {
 if( BOARD_CONNECTED_ITEM::IsType( aScanTypes ) )
 return true;
 
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == PCB_LOCATE_STDVIA_T && m_viaType == VIATYPE::THROUGH )
 return true;
 else if( scanType == PCB_LOCATE_UVIA_T && m_viaType == VIATYPE::MICROVIA )
 return true;
 else if( scanType == PCB_LOCATE_BBVIA_T && m_viaType == VIATYPE::BLIND_BURIED )
 return true;
 }
 
 return false;
 }

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

◆ IsWireImage()

bool EDA_ITEM::IsWireImage ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & IS_WIRE_IMAGE; }

References IS_WIRE_IMAGE, and EDA_ITEM::m_flags.

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

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

References CONTINUE, QUIT, and 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 322 of file eda_item.h.

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

References CONTINUE, QUIT, and 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 941 of file pcb_track.cpp.

{
 const BOARD* board = GetBoard();
 PCB_LAYER_ID top_layer;
 PCB_LAYER_ID bottom_layer;
 
 LayerPair( &top_layer, &bottom_layer );
 
 return board->GetLayerName( top_layer ) + wxT( " - " ) + board->GetLayerName( bottom_layer );
}

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

Referenced by GetMsgPanelInfo(), and GetSelectMenuText().

◆ LayerPair()

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

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

Parameters

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

Definition at line 535 of file pcb_track.cpp.

{
 PCB_LAYER_ID t_layer = F_Cu;
 PCB_LAYER_ID b_layer = B_Cu;
 
 if( GetViaType() != VIATYPE::THROUGH )
 {
 b_layer = m_bottomLayer;
 t_layer = m_layer;
 
 if( b_layer < t_layer )
 std::swap( b_layer, t_layer );
 }
 
 if( top_layer )
 *top_layer = t_layer;
 
 if( bottom_layer )
 *bottom_layer = b_layer;
}

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

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

◆ 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, LIB_TEXTBOX, SCH_FIELD, SCH_PIN, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, SCH_TEXTBOX, FP_TEXT, FP_TEXTBOX, NETINFO_ITEM, PCB_MARKER, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 382 of file eda_item.h.

 {
 return false;
 }

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_EDITOR_CONTROL::HasMatch(), SCH_MARKER::Matches(), LIB_TEXTBOX::Matches(), SCH_FIELD::Matches(), SCH_PIN::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), FP_TEXT::Matches(), FP_TEXTBOX::Matches(), NETINFO_ITEM::Matches(), PCB_MARKER::Matches(), PCB_TEXT::Matches(), PCB_TEXTBOX::Matches(), ZONE::Matches(), SCH_EDITOR_CONTROL::ReplaceAndFindNext(), SCH_DRAWING_TOOLS::TwoClickPlace(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and SCH_EDITOR_CONTROL::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 117 of file eda_item.cpp.

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 return false;
 
 ii = next;
 next += searchText.length();
 
 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
 if( startOK && endOK )
 return true;
 else
 ii++;
 }
 
 return false;
 }
 else if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

References EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ Mirror()

void PCB_TRACK::Mirror	(	const VECTOR2I &	aCentre,
		bool	aMirrorAroundXAxis
	)

virtualinherited

Reimplemented in PCB_ARC.

Definition at line 299 of file pcb_track.cpp.

{
 if( aMirrorAroundXAxis )
 {
 MIRROR( m_Start.y, aCentre.y );
 MIRROR( m_End.y, aCentre.y );
 }
 else
 {
 MIRROR( m_Start.x, aCentre.x );
 MIRROR( m_End.x, aCentre.x );
 }
}

References PCB_TRACK::m_End, PCB_TRACK::m_Start, MIRROR(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

 {
 m_Start += aMoveVector;
 m_End += aMoveVector;
 }

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

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

{
 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
 GetClass() ) );
 
 return false;
}

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

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 165 of file eda_item.h.

165{ return false; }

◆ 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 LIB_TEXTBOX, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 409 of file eda_item.h.

 {
 return false;
 }

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

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.matchCase )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }
 
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }
 
 if( next > ii )
 result += aText.Mid( ii, next - ii );
 
 ii = next;
 next += searchText.length();
 
 bool startOK;
 bool endOK;
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }
 
 if( startOK && endOK )
 {
 result += aSearchData.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

References EDA_SEARCH_DATA::findString, EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::replaceString, text, and WHOLEWORD.

Referenced by EDA_TEXT::Replace(), SCH_FIELD::Replace(), SCH_EDITOR_CONTROL::ReplaceAll(), and SCH_EDITOR_CONTROL::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 284 of file pcb_track.cpp.

{
 RotatePoint( m_Start, aRotCentre, aAngle );
 RotatePoint( m_End, aRotCentre, aAngle );
}

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

◆ SanitizeLayers()

void PCB_VIA::SanitizeLayers ( )

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

Definition at line 569 of file pcb_track.cpp.

{
 if( GetViaType() == VIATYPE::THROUGH )
 {
 m_layer = F_Cu;
 m_bottomLayer = B_Cu;
 }
 
 if( m_bottomLayer < m_layer )
 std::swap( m_bottomLayer, m_layer );
}

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

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

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

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

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

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

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->setter( object, aValue );
 
 return object != nullptr;
 }

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetBottomLayer()

void PCB_VIA::SetBottomLayer ( PCB_LAYER_ID aLayer )

Definition at line 529 of file pcb_track.cpp.

{
 m_bottomLayer = aLayer;
}

References m_bottomLayer.

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

119{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:142

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetDrill()

void PCB_VIA::SetDrill ( int aDrill )

inline

Function SetDrill sets the drill value for vias.

Parameters

aDrill is the new drill diameter

Definition at line 464 of file pcb_track.h.

464{ m_drill = aDrill; }

References m_drill.

Referenced by PNS_KICAD_IFACE::AddItem(), FABMASTER::loadVias(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetDrillDefault()

void PCB_VIA::SetDrillDefault ( )

inline

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

Definition at line 485 of file pcb_track.h.

485{ m_drill = UNDEFINED_DRILL_DIAMETER; }

UNDEFINED_DRILL_DIAMETER

#define UNDEFINED_DRILL_DIAMETER

Definition: pcb_track.h:70

References m_drill, and UNDEFINED_DRILL_DIAMETER.

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

◆ SetEnd()

void PCB_TRACK::SetEnd ( const VECTOR2I & aEnd )

inlineinherited

Definition at line 107 of file pcb_track.h.

107{ m_End = aEnd; }

References PCB_TRACK::m_End.

Referenced by PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_LINE::AddToBoard(), ALTIUM_PCB::ConvertTracks6ToBoardItemOnLayer(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::FilletTracks(), FABMASTER::loadEtch(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetEndX()

void PCB_TRACK::SetEndX ( int aX )

inlineinherited

Definition at line 113 of file pcb_track.h.

113{ m_End.x = aX; }

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

114{ m_End.y = aY; }

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

Referenced by TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

142{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

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

201{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

Referenced by SCH_EDITOR_CONTROL::UpdateFind().

◆ SetIsFree()

void PCB_VIA::SetIsFree ( bool aFree = true )

inline

Definition at line 493 of file pcb_track.h.

493{ m_isFree = aFree; }

References m_isFree.

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

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Definition at line 238 of file board_item.h.

238{ m_isKnockout = aKnockout; }

References BOARD_ITEM::m_isKnockout.

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 167 of file eda_item.h.

 {
 if( aBitmap )
 SetFlags( IS_SHOWN_AS_BITMAP );
 else
 ClearFlags( IS_SHOWN_AS_BITMAP );
 }

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

◆ SetKeepTopBottom()

void PCB_VIA::SetKeepTopBottom ( bool aSet )

inline

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

Definition at line 442 of file pcb_track.h.

442{ m_keepTopBottomLayer = aSet; }

References m_keepTopBottomLayer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ SetLayer()

virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID aLayer )

inlinevirtualinherited

Set the layer this item is on.

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

Parameters

aLayer The layer number.

Reimplemented in PCB_GROUP, PCB_DIMENSION_BASE, and ZONE.

Definition at line 201 of file board_item.h.

 {
 m_layer = aLayer;
 }

References BOARD_ITEM::m_layer.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_ARC::AddToBoard(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), PCAD2KICAD::PCB_ARC::AddToFootprint(), PCAD2KICAD::PCB_LINE::AddToFootprint(), PCAD2KICAD::PCB_POLYGON::AddToFootprint(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BOOST_AUTO_TEST_CASE(), ZONE_CREATE_HELPER::commitZone(), ALTIUM_PCB::ConvertArcs6ToBoardItem(), ALTIUM_PCB::ConvertArcs6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertArcs6ToFootprintItem(), ALTIUM_PCB::ConvertArcs6ToFootprintItemOnLayer(), ALTIUM_PCB::ConvertFills6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertFills6ToFootprintItemOnLayer(), ALTIUM_PCB::ConvertShapeBasedRegions6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertShapeBasedRegions6ToFootprintItemOnLayer(), ALTIUM_PCB::ConvertTexts6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), ALTIUM_PCB::ConvertTracks6ToBoardItem(), ALTIUM_PCB::ConvertTracks6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTracks6ToFootprintItem(), ALTIUM_PCB::ConvertTracks6ToFootprintItemOnLayer(), MICROWAVE_TOOL::createMicrowaveInductor(), PCB_BASE_FRAME::CreateNewFootprint(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::drawArc(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::drawShape(), PAD_TOOL::explodePad(), EDIT_TOOL::FilletTracks(), FOOTPRINT::Flip(), FP_SHAPE::Flip(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_SHAPE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), FOOTPRINT_DESC::FOOTPRINT_DESC(), FP_TEXT::FP_TEXT(), GENDRILL_WRITER_BASE::genDrillMapFile(), ALTIUM_PCB::HelperCreateBoardOutline(), ALTIUM_PCB::HelperParseDimensions6Datum(), ALTIUM_PCB::HelperParseDimensions6Leader(), ALTIUM_PCB::HelperParsePad6NonCopper(), initTextTable(), FABMASTER::loadEtch(), LEGACY_PLUGIN::loadFOOTPRINT(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), FABMASTER::loadPolygon(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), main(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), GRAPHICS_CLEANER::mergeRects(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), EAGLE_PLUGIN::packageCircle(), EAGLE_PLUGIN::packagePolygon(), EAGLE_PLUGIN::packageRectangle(), EAGLE_PLUGIN::packageText(), EAGLE_PLUGIN::packageWire(), ALTIUM_PCB::ParseComponents6Data(), GPCB_FPL_CACHE::parseFOOTPRINT(), PCB_MARKER::PCB_MARKER(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DRAWING_TOOL::PlaceText(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), processTextItem(), PCB_CONTROL::pruneItemLayers(), PNS_PCBNEW_RULE_RESOLVER::QueryConstraint(), DIALOG_PAD_PROPERTIES::redraw(), CLIPBOARD_IO::SaveSelection(), PCB_DIMENSION_BASE::SetLayer(), BOARD_ITEM::SetLayerSet(), GLOBAL_EDIT_TOOL::swapBoardItem(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ SetLayerPair()

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

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

Parameters

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

Definition at line 514 of file pcb_track.cpp.

{
 
 m_layer = aTopLayer;
 m_bottomLayer = aBottomLayer;
 SanitizeLayers();
}

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

Referenced by PNS_KICAD_IFACE::AddItem(), Flip(), ROUTER_TOOL::handleLayerSwitch(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetLayerSet()

void PCB_VIA::SetLayerSet ( LSET aLayers )

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 497 of file pcb_track.cpp.

{
 bool first = true;
 
 for( PCB_LAYER_ID layer : aLayerSet.Seq() )
 {
 if( first )
 {
 m_layer = layer;
 first = false;
 }
 
 m_bottomLayer = layer;
 }
}

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

◆ SetLocalRatsnestVisible()

void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible ( bool aVisible )

inlineinherited

Definition at line 166 of file board_connected_item.h.

 {
 m_localRatsnestVisible = aVisible;
 }

References BOARD_CONNECTED_ITEM::m_localRatsnestVisible.

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

{
 SetFlags( IS_CHANGED );
 
 // If this a child object, then the parent modification state also needs to be set.
 if( m_parent )
 m_parent->SetModified();
}

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

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_SYMBOL::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), PCB_PARSER::parseZONE(), LIB_SYMBOL::RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::SetUnit().

◆ SetNet()

void BOARD_CONNECTED_ITEM::SetNet ( NETINFO_ITEM * aNetInfo )

inlineinherited

Set a NET_INFO object for the item.

Definition at line 83 of file board_connected_item.h.

 {
 m_netinfo = aNetInfo;
 }

References BOARD_CONNECTED_ITEM::m_netinfo.

Referenced by BOOST_AUTO_TEST_CASE(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), FABMASTER::loadEtch(), CADSTAR_PCB_ARCHIVE_LOADER::loadNets(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), FABMASTER::loadVias(), FABMASTER::loadZone(), main(), and CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes().

◆ SetNetCode() [1/2]

void BOARD_CONNECTED_ITEM::SetNetCode ( int aNetCode )

inlineinherited

Definition at line 106 of file board_connected_item.h.

 {
 SetNetCode( aNetCode, false );
 }

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

{
 if( !IsOnCopperLayer() )
 aNetCode = 0;
 
 // if aNetCode < 0 (typically NETINFO_LIST::FORCE_ORPHANED) or no parent board,
 // set the m_netinfo to the dummy NETINFO_LIST::ORPHANED
 
 BOARD* board = GetBoard();
 
 if( ( aNetCode >= 0 ) && board )
 m_netinfo = board->FindNet( aNetCode );
 else
 m_netinfo = NETINFO_LIST::OrphanedItem();
 
 if( !aNoAssert )
 wxASSERT( m_netinfo );
 
 return ( m_netinfo != nullptr );
}

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

Referenced by BOARD::AddArea(), PNS_KICAD_IFACE::AddItem(), PCAD2KICAD::PCB_LINE::AddToBoard(), PCAD2KICAD::PCB_POLYGON::AddToBoard(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), ALTIUM_PCB::ConvertArcs6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertFills6ToBoardItemWithNet(), ALTIUM_PCB::ConvertTracks6ToBoardItemOnLayer(), TEARDROP_MANAGER::createTeardrop(), PCB_EDIT_FRAME::Edit_Zone_Params(), ZONE_SETTINGS::ExportSetting(), FOOTPRINT::FOOTPRINT(), FP_ZONE::FP_ZONE(), ROUTER_TOOL::handleLayerSwitch(), EAGLE_PLUGIN::loadPlain(), EAGLE_PLUGIN::loadSignals(), LEGACY_PLUGIN::loadTrackList(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), FOOTPRINT::operator=(), ALTIUM_PCB::ParsePolygons6Data(), BOARD_CONNECTED_ITEM::SetNetCode(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and PCB_DIMENSION_BASE.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

Definition at line 61 of file board_item.h.

61{ m_group = aGroup; }

References BOARD_ITEM::m_group.

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

◆ SetPosition()

void PCB_VIA::SetPosition ( const VECTOR2I & aPoint )

inlineoverridevirtual

Reimplemented from PCB_TRACK.

Definition at line 402 of file pcb_track.h.

402{ m_Start = aPoint; m_End = aPoint; }

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

Referenced by PNS_KICAD_IFACE::AddItem(), FABMASTER::loadVias(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetRemoveUnconnected()

void PCB_VIA::SetRemoveUnconnected ( bool aSet )

inline

Sets the unconnected removal property.

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

Definition at line 436 of file pcb_track.h.

436{ m_removeUnconnectedLayer = aSet; }

References m_removeUnconnectedLayer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

118{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetStart()

void PCB_TRACK::SetStart ( const VECTOR2I & aStart )

inlineinherited

Definition at line 110 of file pcb_track.h.

110{ m_Start = aStart; }

References PCB_TRACK::m_Start.

Referenced by PNS_KICAD_IFACE::AddItem(), ALTIUM_PCB::ConvertTracks6ToBoardItemOnLayer(), EDIT_TOOL::DragArcTrack(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::FilletTracks(), FABMASTER::loadEtch(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetState()

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

inlineinherited

Definition at line 131 of file eda_item.h.

 {
 if( state )
 m_status |= type; // state = ON or OFF
 else
 m_status &= ~type;
 }

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), and TRACKS_CLEANER::mergeCollinearSegments().

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 140 of file eda_item.h.

140{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 82 of file board_item.cpp.

{
 wxCHECK( false, /* void */ );
}

◆ SetTopLayer()

void PCB_VIA::SetTopLayer ( PCB_LAYER_ID aLayer )

Definition at line 523 of file pcb_track.cpp.

{
 m_layer = aLayer;
}

References BOARD_ITEM::m_layer.

Referenced by DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow().

◆ SetViaType()

void PCB_VIA::SetViaType ( VIATYPE aViaType )

inline

Definition at line 354 of file pcb_track.h.

354{ m_viaType = aViaType; }

References m_viaType.

Referenced by PNS_KICAD_IFACE::AddItem(), ROUTER_TOOL::handleLayerSwitch(), PCB_VIA(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), and PNS_KICAD_IFACE::UpdateItem().

◆ SetWidth()

void PCB_TRACK::SetWidth ( int aWidth )

inlineinherited

◆ SetWireImage()

void EDA_ITEM::SetWireImage ( )

inlineinherited

Definition at line 117 of file eda_item.h.

117{ SetFlags( IS_WIRE_IMAGE ); }

References IS_WIRE_IMAGE, and EDA_ITEM::SetFlags().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 88 of file board_item.h.

 {
 VECTOR2I p( aX, GetY() );
 SetPosition( p );
 }

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

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

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 94 of file board_item.h.

 {
 VECTOR2I p( GetX(), aY );
 SetPosition( p );
 }

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

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

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

438{ return *aLeft < *aRight; }

◆ SwapData()

void PCB_VIA::SwapData ( BOARD_ITEM * aImage )

overridevirtual

Swap data between aItem and aImage.

aItem and aImage should have the same type.

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

Parameters

aImage the item image which contains data to swap.

Reimplemented from PCB_TRACK.

Definition at line 1080 of file pcb_track.cpp.

{
 assert( aImage->Type() == PCB_VIA_T );
 
 std::swap( *((PCB_VIA*) this), *((PCB_VIA*) aImage) );
}

References PCB_VIA_T, and EDA_ITEM::Type().

◆ TopLayer()

PCB_LAYER_ID PCB_VIA::TopLayer ( ) const

Definition at line 557 of file pcb_track.cpp.

{
 return m_layer;
}

References BOARD_ITEM::m_layer.

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

◆ TransformShapeWithClearanceToPolygon()

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

overridevirtualinherited

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 1171 of file pcb_track.cpp.

{
 wxASSERT_MSG( !ignoreLineWidth, wxT( "IgnoreLineWidth has no meaning for tracks." ) );
 
 
 switch( Type() )
 {
 case PCB_VIA_T:
 {
 int radius = ( m_Width / 2 ) + aClearanceValue;
 TransformCircleToPolygon( aCornerBuffer, m_Start, radius, aError, aErrorLoc );
 break;
 }
 
 case PCB_ARC_T:
 {
 const PCB_ARC* arc = static_cast<const PCB_ARC*>( this );
 int width = m_Width + ( 2 * aClearanceValue );
 
 TransformArcToPolygon( aCornerBuffer, arc->GetStart(), arc->GetMid(),
 arc->GetEnd(), width, aError, aErrorLoc );
 break;
 }
 
 default:
 {
 int width = m_Width + ( 2 * aClearanceValue );
 
 TransformOvalToPolygon( aCornerBuffer, m_Start, m_End, width, aError, aErrorLoc );
 break;
 }
 }
}

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

Referenced by BOARD_ADAPTER::createLayers().

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

97{ return m_structType; }

EDA_ITEM::m_structType

KICAD_T m_structType

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

Definition: eda_item.h:505

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

{
 BOX2I bbox = GetBoundingBox();
 const BOARD* board = GetBoard();
 
 if( board )
 bbox.Inflate( 2 * board->GetDesignSettings().GetBiggestClearanceValue() );
 else
 bbox.Inflate( GetWidth() ); // Add a bit extra for safety
 
 return bbox;
}

References BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue(), BOARD_ITEM::GetBoard(), PCB_TRACK::GetBoundingBox(), BOARD::GetDesignSettings(), 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, RATSNEST_VIEW_ITEM, ROUTER_PREVIEW_ITEM, MY_DRAWING, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::ORIGIN_VIEWITEM, KIGFX::VIEW_GROUP, and KIGFX::VIEW_OVERLAY.

Definition at line 106 of file view_item.h.

107 {}

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

◆ ViewGetLayers()

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

overridevirtual

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

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

Parameters

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

Reimplemented from PCB_TRACK.

Definition at line 712 of file pcb_track.cpp.

{
 aLayers[0] = LAYER_VIA_HOLES;
 aLayers[1] = LAYER_VIA_HOLEWALLS;
 aLayers[2] = LAYER_VIA_NETNAMES;
 
 // Just show it on common via & via holes layers
 switch( GetViaType() )
 {
 case VIATYPE::THROUGH: aLayers[3] = LAYER_VIA_THROUGH; break;
 case VIATYPE::BLIND_BURIED: aLayers[3] = LAYER_VIA_BBLIND; break;
 case VIATYPE::MICROVIA: aLayers[3] = LAYER_VIA_MICROVIA; break;
 default: aLayers[3] = LAYER_GP_OVERLAY; break;
 }
 
 aCount = 4;
 
 if( IsLocked() )
 aLayers[ aCount++ ] = LAYER_LOCKED_ITEM_SHADOW;
}

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

◆ ViewGetLOD()

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

overridevirtual

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

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

Parameters

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

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

Reimplemented from PCB_TRACK.

Definition at line 734 of file pcb_track.cpp.

{
 constexpr double HIDE = (double)std::numeric_limits<double>::max();
 
 PCB_PAINTER* painter = static_cast<PCB_PAINTER*>( aView->GetPainter() );
 PCB_RENDER_SETTINGS* renderSettings = painter->GetSettings();
 const BOARD* board = GetBoard();
 LSET visible = LSET::AllLayersMask();
 
 // Meta control for hiding all vias
 if( !aView->IsLayerVisible( LAYER_VIAS ) )
 return HIDE;
 
 // Handle board visibility
 if( board )
 visible = board->GetVisibleLayers() & board->GetEnabledLayers();
 
 // In high contrast mode don't show vias that don't cross the high-contrast layer
 if( renderSettings->GetHighContrast() )
 {
 PCB_LAYER_ID highContrastLayer = renderSettings->GetPrimaryHighContrastLayer();
 
 if( LSET::FrontTechMask().Contains( highContrastLayer ) )
 highContrastLayer = F_Cu;
 else if( LSET::BackTechMask().Contains( highContrastLayer ) )
 highContrastLayer = B_Cu;
 
 if( !GetLayerSet().Contains( highContrastLayer ) )
 return HIDE;
 }
 
 if( IsViaPadLayer( aLayer ) )
 {
 if( !FlashLayer( visible ) )
 return HIDE;
 }
 else if( IsHoleLayer( aLayer ) )
 {
 if( m_viaType == VIATYPE::BLIND_BURIED || m_viaType == VIATYPE::MICROVIA )
 {
 // Show a blind or micro via's hole if it crosses a visible layer
 if( !( visible & GetLayerSet() ).any() )
 return HIDE;
 }
 else
 {
 // Show a through via's hole if any physical layer is shown
 if( !( visible & LSET::PhysicalLayersMask() ).any() )
 return HIDE;
 }
 }
 else if( IsNetnameLayer( aLayer ) )
 {
 if( renderSettings->GetHighContrast() )
 {
 // Hide netnames unless via is flashed to a high-contrast layer
 if( !FlashLayer( renderSettings->GetPrimaryHighContrastLayer() ) )
 return HIDE;
 }
 else
 {
 // Hide netnames unless pad is flashed to a visible layer
 if( !FlashLayer( visible ) )
 return HIDE;
 }
 
 // Netnames will be shown only if zoom is appropriate
 return m_Width == 0 ? HIDE : ( (double)pcbIUScale.mmToIU( 10 ) / m_Width );
 }
 
 // Passed all tests; show.
 return 0.0;
}

References LSET::AllLayersMask(), B_Cu, LSET::BackTechMask(), BLIND_BURIED, F_Cu, FlashLayer(), LSET::FrontTechMask(), BOARD_ITEM::GetBoard(), BOARD::GetEnabledLayers(), KIGFX::RENDER_SETTINGS::GetHighContrast(), GetLayerSet(), KIGFX::VIEW::GetPainter(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), KIGFX::PCB_PAINTER::GetSettings(), BOARD::GetVisibleLayers(), IsHoleLayer(), KIGFX::VIEW::IsLayerVisible(), IsNetnameLayer(), IsViaPadLayer(), LAYER_VIAS, m_viaType, PCB_TRACK::m_Width, MICROVIA, EDA_IU_SCALE::mmToIU(), pcbIUScale, and LSET::PhysicalLayersMask().

◆ viewPrivData()

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

inlineinherited

◆ 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 405 of file pcb_track.cpp.

{
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == Type() )
 {
 if( INSPECT_RESULT::QUIT == inspector( this, testData ) )
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
}

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

Member Data Documentation

◆ m_bottomLayer

PCB_LAYER_ID PCB_VIA::m_bottomLayer

private

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

Definition at line 512 of file pcb_track.h.

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

◆ m_drill

int PCB_VIA::m_drill

private

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

Definition at line 516 of file pcb_track.h.

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

◆ m_End

VECTOR2I PCB_TRACK::m_End

protectedinherited

Line end point.

Definition at line 241 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(), PCB_ARC::PCB_ARC(), PCB_TRACK::Rotate(), PCB_ARC::Rotate(), PCB_TRACK::SetEnd(), PCB_TRACK::SetEndX(), PCB_TRACK::SetEndY(), SetPosition(), and PCB_TRACK::TransformShapeWithClearanceToPolygon().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 498 of file eda_item.h.

Referenced by EDA_ITEM::ClearFlags(), LIB_TEXT::Clone(), DS_DRAW_ITEM_BASE::DS_DRAW_ITEM_BASE(), EDA_ITEM::GetEditFlags(), EDA_ITEM::GetFlags(), PCB_TRACK::GetMsgPanelInfoBase_Common(), SCH_LINE::GetSelectedPoints(), EDA_ITEM::HasFlag(), LIB_ITEM::HitTest(), LIB_SHAPE::HitTest(), LIB_TEXT::HitTest(), SCH_JUNCTION::HitTest(), SCH_LINE::HitTest(), SCH_SYMBOL::HitTest(), LIB_PIN::HitTest(), SCH_PIN::HitTest(), ZONE::InitDataFromSrcInCopyCtor(), EDA_ITEM::IsBrightened(), SCH_ITEM::IsConnected(), EDA_ITEM::IsDragging(), EDA_ITEM::IsEntered(), EDA_ITEM::IsModified(), EDA_ITEM::IsMoving(), EDA_ITEM::IsNew(), EDA_ITEM::IsResized(), EDA_ITEM::IsRollover(), EDA_ITEM::IsSelected(), EDA_ITEM::IsShownAsBitmap(), EDA_ITEM::IsWireImage(), SCH_LINE::MirrorHorizontally(), SCH_LINE::MirrorVertically(), EDA_ITEM::operator=(), SCH_LINE::Rotate(), EDA_ITEM::SetFlags(), and PCB_SHAPE::SwapData().

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 497 of file eda_item.h.

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

◆ m_group

PCB_GROUP* BOARD_ITEM::m_group

protectedinherited

Definition at line 322 of file board_item.h.

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

◆ m_isFree

bool PCB_VIA::m_isFree

private

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

Definition at line 520 of file pcb_track.h.

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

◆ m_isKnockout

bool BOARD_ITEM::m_isKnockout

protectedinherited

Definition at line 318 of file board_item.h.

Referenced by BOARD_ITEM::IsKnockout(), and BOARD_ITEM::SetIsKnockout().

◆ m_isLocked

bool BOARD_ITEM::m_isLocked

protectedinherited

Definition at line 320 of file board_item.h.

Referenced by BOARD_ITEM::IsLocked(), and BOARD_ITEM::SetLocked().

◆ m_keepTopBottomLayer

bool PCB_VIA::m_keepTopBottomLayer

private

Keep the top and bottom annular rings.

Definition at line 519 of file pcb_track.h.

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

◆ m_LastNetnamePosition

VECTOR2I PCB_TRACK::m_LastNetnamePosition

mutableinherited

Definition at line 236 of file pcb_track.h.

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

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 317 of file board_item.h.

Referenced by FlashLayer(), FOOTPRINT::FOOTPRINT(), FP_SHAPE::FP_SHAPE(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetLayerSet(), GetLayerSet(), PCB_BITMAP::GetMsgPanelInfo(), PAD::GetPrincipalLayer(), PCB_TRACK::GetWidthConstraint(), BOARD_ITEM::IsOnLayer(), FOOTPRINT::IsOnLayer(), IsOnLayer(), PCB_SHAPE::IsType(), LayerPair(), PCB_DIMENSION_BASE::PCB_DIMENSION_BASE(), PCB_TARGET::PCB_TARGET(), SanitizeLayers(), PCB_MARKER::Serialize(), BOARD_ITEM::SetLayer(), PCB_DIMENSION_BASE::SetLayer(), SetLayerPair(), SetLayerSet(), SetTopLayer(), PCB_SHAPE::SwapData(), TopLayer(), BOARD_ITEM::ViewGetLayers(), FOOTPRINT::ViewGetLayers(), PCB_BITMAP::ViewGetLayers(), FOOTPRINT::ViewGetLOD(), PCB_BITMAP::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 181 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 178 of file board_connected_item.h.

Referenced by BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), BOARD_CONNECTED_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), BOARD_CONNECTED_ITEM::GetShortNetname(), ZONE::InitDataFromSrcInCopyCtor(), BOARD_CONNECTED_ITEM::SetNet(), and BOARD_CONNECTED_ITEM::SetNetCode().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 496 of file eda_item.h.

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::DoHypertextAction(), FP_TEXT::FP_TEXT(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), FP_TEXTBOX::GetDrawRotation(), SCH_FIELD::GetMenuImage(), FP_SHAPE::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), LIB_ITEM::GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParent(), EDA_ITEM::GetParent(), PAD::GetParent(), FP_SHAPE::GetParentAsString(), FP_TEXT::GetParentAsString(), FP_TEXTBOX::GetParentAsString(), PAD::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_FIELD::GetShownText(), LIB_FIELD::HitTest(), SCH_FIELD::IsHypertext(), SCH_FIELD::IsReplaceable(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), EDA_ITEM::operator=(), LIB_FIELD::operator=(), PAD::PAD(), SCH_FIELD::Plot(), SCH_FIELD::Print(), SCH_FIELD::Replace(), SCH_LABEL_BASE::ResolveTextVar(), SCH_SYMBOL::SCH_SYMBOL(), FP_SHAPE::SetDrawCoord(), FP_TEXT::SetDrawCoord(), PAD::SetDrawCoord(), SCH_FIELD::SetId(), FP_SHAPE::SetLocalCoord(), FP_TEXT::SetLocalCoord(), PAD::SetLocalCoord(), EDA_ITEM::SetModified(), EDA_ITEM::SetParent(), SCH_FIELD::SetPosition(), and PCB_SHAPE::SwapData().

◆ m_removeUnconnectedLayer

bool PCB_VIA::m_removeUnconnectedLayer

private

Remove unconnected copper on a via.

Definition at line 518 of file pcb_track.h.

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

◆ m_Start

VECTOR2I PCB_TRACK::m_Start

protectedinherited

Line start point.

Definition at line 240 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(), 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::HitTest(), HitTest(), PCB_ARC::IsCCW(), PCB_TRACK::IsNull(), PCB_TRACK::IsPointOnEnds(), PCB_TRACK::Mirror(), PCB_ARC::Mirror(), PCB_TRACK::Move(), PCB_ARC::Move(), PCB_ARC::PCB_ARC(), PCB_TRACK::Rotate(), PCB_ARC::Rotate(), SetPosition(), PCB_TRACK::SetPosition(), PCB_ARC::SetPosition(), PCB_TRACK::SetStart(), and PCB_TRACK::TransformShapeWithClearanceToPolygon().

◆ m_status

EDA_ITEM_FLAGS EDA_ITEM::m_status

protectedinherited

Definition at line 495 of file eda_item.h.

Referenced by EDA_ITEM::GetState(), EDA_ITEM::GetStatus(), EDA_ITEM::operator=(), EDA_ITEM::SetState(), EDA_ITEM::SetStatus(), and PCB_SHAPE::SwapData().

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

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 492 of file eda_item.h.

◆ m_viaType

VIATYPE PCB_VIA::m_viaType

private

through, blind/buried or micro

Definition at line 514 of file pcb_track.h.

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

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 151 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW_ITEM::ClearViewPrivData(), KIGFX::VIEW_ITEM::viewPrivData(), and KIGFX::VIEW_ITEM::~VIEW_ITEM().

◆ m_Width

int PCB_TRACK::m_Width

protectedinherited

Thickness of track, or via diameter.

Definition at line 239 of file pcb_track.h.

Referenced by PCB_TRACK::GetBoundingBox(), PCB_TRACK::GetEffectiveShape(), GetEffectiveShape(), PCB_TRACK::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TRACK::GetWidth(), PCB_TRACK::HitTest(), PCB_ARC::HitTest(), HitTest(), PCB_TRACK::IsPointOnEnds(), PCB_TRACK::PCB_TRACK(), PCB_TRACK::SetWidth(), PCB_TRACK::TransformShapeWithClearanceToPolygon(), PCB_TRACK::ViewGetLOD(), and ViewGetLOD().

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

Definition at line 131 of file board_item.h.

Referenced by BOARD::GetPosition().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_VIA()

Member Function Documentation

◆ ApproxCollinear()

◆ BottomLayer()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ DeleteStructure()

◆ Duplicate()

◆ FlashLayer() [1/2]

◆ FlashLayer() [2/2]

◆ Flip()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetDrill()

◆ GetDrillValue()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveNetClass()

◆ GetEffectiveShape()

◆ GetEnd()

◆ GetEndPoint()

◆ GetEndX()

◆ GetEndY()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetIsFree()

◆ GetKeepTopBottom()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetLength()

◆ GetLocalClearance()

◆ GetLocalClearanceOverrides()

◆ GetLocalRatsnestVisible()

◆ GetMenuImage()

◆ GetMinAnnulus()

◆ GetMsgPanelInfo()

◆ GetMsgPanelInfoBase_Common()

◆ GetNet()

◆ GetNetClassName()

◆ GetNetCode()

◆ GetNetname()

◆ GetNetnameMsg()

◆ GetOwnClearance()

◆ GetParent()

◆ GetParentFootprint()

◆ GetParentGroup()

◆ GetPosition()

◆ GetRemoveUnconnected()

◆ GetSelectMenuText()

◆ GetShortNetname()

◆ GetSolderMaskExpansion()

◆ GetSortPosition()

◆ GetStart()

◆ GetState()

◆ GetStatus()

◆ GetStroke()

◆ GetTypeDesc()

◆ GetViaType()