A drill chart placed on the board, kept in step with the holes. More...

#include <pcb_drill_chart.h>

Inheritance diagram for PCB_DRILL_CHART:

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

Public Member Functions
	PCB_DRILL_CHART (BOARD_ITEM *aParent)

	PCB_DRILL_CHART (const PCB_DRILL_CHART &aOther)

	~PCB_DRILL_CHART () override=default

PCB_DRILL_CHART &	operator= (const PCB_DRILL_CHART &)=delete

wxString	GetClass () const override
	Return the class name.

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

DRILL_CHART_FILTER &	Filter ()

const DRILL_CHART_FILTER &	Filter () const

std::vector< DRILL_CHART_COLUMN > &	Columns ()

const std::vector< DRILL_CHART_COLUMN > &	Columns () const

DRILL_CHART_UNITS	GetUnits () const

void	SetUnits (DRILL_CHART_UNITS aUnits)

int	GetPrecision () const

void	SetPrecision (int aPrecision)
	Clamped.

bool	GetShowTotals () const

void	SetShowTotals (bool aShow)

uint64_t	GetBuiltGeneration () const
	Board drill generation the cells were built at.

void	ApplyTemplate (const DRILL_CHART_TEMPLATE &aTemplate)
	Copy a template's formatting.

void	RebuildCells (const BOARD &aBoard, DRILL_SYMBOL_PROFILE *aAssignedProfile=nullptr)
	Regenerate the cells from the board.

const std::map< int, int > &	RowShapes () const
	Curated shape index for each generated row, by table row.

std::map< int, int > &	RowShapes ()

const std::map< int, std::string > &	RowKeys () const
	Drill group each generated row reports on, by table row.

std::map< int, std::string > &	RowKeys ()

bool	IsDataRow (int aRow) const
	True for a row that reports a drill group, false for the title, heading and totals.

int	GetSymbolColumn () const
	Table column the symbol is drawn in, or -1 when the chart has no symbol column.

void	SetSymbolColumn (int aCol)

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.

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

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.

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

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

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

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

void	SetStrokeExternal (bool aDoStroke)

bool	StrokeExternal () const

void	SetStrokeHeaderSeparator (bool aDoStroke)

bool	StrokeHeaderSeparator () const

void	SetBorderStroke (const STROKE_PARAMS &aParams)

const STROKE_PARAMS &	GetBorderStroke () const

void	SetBorderWidth (int aWidth)

int	GetBorderWidth () const

void	SetBorderStyle (const LINE_STYLE aStyle)

LINE_STYLE	GetBorderStyle () const

void	SetBorderColor (const COLOR4D &aColor)

COLOR4D	GetBorderColor () const

void	SetSeparatorsStroke (const STROKE_PARAMS &aParams)

const STROKE_PARAMS &	GetSeparatorsStroke () const

void	SetSeparatorsWidth (int aWidth)

int	GetSeparatorsWidth () const

void	SetSeparatorsStyle (const LINE_STYLE aStyle)

LINE_STYLE	GetSeparatorsStyle () const

void	SetSeparatorsColor (const COLOR4D &aColor)

COLOR4D	GetSeparatorsColor () const

void	SetStrokeColumns (bool aDoStroke)

bool	StrokeColumns () const

void	SetStrokeRows (bool aDoStroke)

bool	StrokeRows () const

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

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

void	SetPosition (const VECTOR2I &aPos) override

VECTOR2I	GetPosition () const override

VECTOR2I	GetEnd () const

void	SetPositionX (int x)

void	SetPositionY (int y)

int	GetPositionX () const

int	GetPositionY () const

void	SetColCount (int aCount)

int	GetColCount () const

int	GetRowCount () const

void	SetColWidth (int aCol, int aWidth)

int	GetColWidth (int aCol) const

void	SetRowHeight (int aRow, int aHeight)

int	GetRowHeight (int aRow) const

PCB_TABLECELL *	GetCell (int aRow, int aCol) const

std::vector< PCB_TABLECELL * >	GetCells () const

void	AddCell (PCB_TABLECELL *aCell)

void	InsertCell (int aIdx, PCB_TABLECELL *aCell)

void	ResizeCells (int aRows, int aCols)
	Grow or shrink to aRows x aCols, keeping the cells that already exist.

void	ClearCells ()

void	DeleteMarkedCells ()

void	Add (BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT, bool aSkipConnectivity=false) override
	Adds an item to the container.

void	Remove (BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL) override
	Removes an item from the container.

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

void	Autosize ()

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

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

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

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

void	OnFootprintTransformed () override
	Hook for items inside a footprint to refresh after the FP transform changes (translate, rotate, flip).

void	OnFootprintRescaled (double aRatioX, double aRatioY, double aLinearFactor, const VECTOR2I &aAnchor, const EDA_ANGLE &aParentRotate) override
	Apply a parent footprint scale to this item.

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

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

void	DrawBorders (const std::function< void(const VECTOR2I &aPt1, const VECTOR2I &aPt2, const STROKE_PARAMS &aStroke)> &aCallback) const

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

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

void	TransformShapeToPolySet (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS *aRenderSettings=nullptr) const override
	Convert the TABLE shape to a polyset.

void	TransformGraphicItemsToPolySet (SHAPE_POLY_SET &aBuffer, int aMaxError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS *aRenderSettings) const
	Convert graphic items (segments and texts) to a set of polygonal shapes.

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

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

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

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

bool	HitTest (const SHAPE_LINE_CHAIN &aPoly, bool aContained) const override
	Test if aPoly intersects this item.

BOARD_ITEM *	Duplicate (bool addToParentGroup, BOARD_COMMIT *aCommit=nullptr) const override
	Create a copy of this BOARD_ITEM.

void	CopyFrom (const BOARD_ITEM *aOther) override

bool	operator== (const PCB_TABLE &aOther) const

virtual void	Delete (BOARD_ITEM *aItem)
	Removes an item from the container and deletes it.

bool	IsGroupableType () const

int	GetX () const

int	GetY () const

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

void	SetX (int aX)

void	SetY (int aY)

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

virtual bool	IsOnCopperLayer () const

virtual bool	HasHole () const

virtual bool	HasDrilledHole () const

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

virtual std::shared_ptr< SHAPE_SEGMENT >	GetEffectiveHoleShape (PCB_LAYER_ID aLayer=UNDEFINED_LAYER, DRC_CONSTRAINT_T aUsage=NULL_CONSTRAINT) const

BOARD_ITEM_CONTAINER *	GetParent () const

FOOTPRINT *	GetParentFootprint () const

void	SetUuidDirect (const KIID &aUuid)
	Raw UUID assignment.

void	ResetUuidDirect ()

void	SetUuid (const KIID &aUuid)

void	ResetUuid ()

virtual void	RemapKIIDs (const std::map< KIID, KIID > &aIdMap)
	Remap KIIDs this item stores to reference other items (e.g.

VECTOR2I	GetFPRelativePosition () const

void	SetFPRelativePosition (const VECTOR2I &aPos)

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

virtual bool	IsLayerAgnostic () const
	Check if this item's layer set must not be confined to a board's enabled layers.

virtual bool	FitsEnabledLayers (const LSET &aEnabledLayers, int aCopperLayerCount) const
	Check if a board offering aEnabledLayers can hold this item.

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

const KIFONT::METRICS &	GetFontMetrics () const

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

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

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

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

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

virtual void	SetLayerSet (const LSET &aLayers)

bool	IsSideSpecific () const

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

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

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

bool	IsLocked () const override

void	SetLocked (bool aLocked) override

bool	IsIndexedInBoard () const

int	GetMaxError () const

virtual void	StyleFromSettings (const BOARD_DESIGN_SETTINGS &settings, bool aCheckSide)

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

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

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

virtual BOARD *	GetBoard ()

wxString	GetParentAsString () const
	For "parent" property.

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

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

const std::vector< wxString > *	GetEmbeddedFonts () override

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

KICAD_T	Type () const
	Returns the type of object.

virtual void	SetParent (EDA_ITEM *aParent)

virtual void	SetParentGroup (EDA_GROUP *aGroup)

virtual EDA_GROUP *	GetParentGroup () const

KIID	GetParentGroupId () const

bool	HasSelectedAncestorGroup () const

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsNetHighlighted () const
	Net highlighting must not clear brightening owned by find or picker tools.

void	SetNetHighlighted (bool aHighlighted)

bool	IsRollover () const

VECTOR2I	GetRolloverPos () const

void	SetIsRollover (bool aIsRollover, const VECTOR2I &aMousePos)

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

virtual void	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

virtual void	ClearTempFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

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

bool	IsForceVisible () const

const std::map< wxString, wxString > &	GetCustomProperties () const
	Custom user-defined string key/value properties attached to this item.

void	SetCustomProperties (const std::map< wxString, wxString > &aProps)

void	SetCustomProperty (const wxString &aKey, const wxString &aValue)

bool	HasCustomProperties () const

void	ClearCustomProperties ()

void	RemoveCustomProperty (const wxString &aKey)

std::vector< wxString >	RemoveConflictingCustomProperties ()
	Remove custom properties whose keys collide with an existing field or built-in property name (matched case-insensitively).

bool	GetCustomProperty (const wxString &aKey, wxString &aValue) const

std::vector< PROPERTY_BASE * >	GetCustomPropertiesAsInspectables () const

std::vector< PROPERTY_BASE * >	GetDynamicProperties () const override
	Return dynamically-computed properties specific to this object instance (e.g.

virtual wxString	GetFriendlyName () const

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

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

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

virtual wxString	DisambiguateItemDescription (UNITS_PROVIDER *aUnitsProvider, bool aFull) const

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

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

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

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

virtual EMBEDDED_FILES *	GetEmbeddedFiles ()

bool	IsSCH_ITEM () const

bool	IsBOARD_ITEM () const

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

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

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

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

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

static int	Compare (const PCB_TABLE aTable, const PCB_TABLE aOther)

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

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

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

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

Public Attributes
const KIID	m_Uuid

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

Protected Member Functions
void	swapData (BOARD_ITEM *aImage) override

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

EDA_ITEM *	findParent (KICAD_T aType) const

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

Protected Attributes
bool	m_strokeExternal

bool	m_StrokeHeaderSeparator

STROKE_PARAMS	m_borderStroke

bool	m_strokeRows

bool	m_strokeColumns

STROKE_PARAMS	m_separatorsStroke

int	m_colCount

std::map< int, int >	m_colWidths

std::map< int, int >	m_rowHeights

std::vector< PCB_TABLECELL * >	m_cells

PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

BOARD *	m_boardCacheOwner = nullptr

EDA_ITEM_FLAGS	m_flags

EDA_ITEM *	m_parent
	Owner.

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

VECTOR2I	m_rolloverPos

bool	m_isRollover

bool	m_forceVisible

bool	m_netHighlighted = false

std::map< wxString, wxString >	m_customProperties

std::map< wxString, std::unique_ptr< PROPERTY_BASE > >	m_dynamicCustomPropsCache
	Per-key cache of dynamic property descriptors for m_customProperties, owned by this object.

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

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

Private Member Functions
std::vector< DRILL_CHART_GROUP >	buildGroups (const BOARD &aBoard) const
	The board data this chart reports on, as chart rows.

void	migrateRows (int aRows, int aCols, int aFirstDataRow, const std::vector< std::string > &aNewRowKeys)
	Move each row's cells to the row that reports the same drill group.

Private Attributes
DRILL_CHART_FILTER	m_filter

std::vector< DRILL_CHART_COLUMN >	m_columns

DRILL_CHART_UNITS	m_units

int	m_precision

bool	m_showTotals

std::map< int, int >	m_rowShapes

std::map< int, std::string >	m_rowKeys

int	m_symbolColumn

uint64_t	m_builtGeneration

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

bool	m_isSCH_ITEM

bool	m_isBOARD_ITEM

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items.

Detailed Description

A drill chart placed on the board, kept in step with the holes.

The chart owns a materialized copy of its columns rather than pointing at a template, so importing or editing a template can never rewrite a fabrication drawing that has already been approved. Grouping and symbols come from the board's shared symbol profile so that a chart and the drill map beside it cannot disagree.

Definition at line 50 of file pcb_drill_chart.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum BOARD_ITEM::COMPARE_FLAGS : int

inherited

Enumerator
DRC
INSTANCE_TO_INSTANCE

Definition at line 556 of file board_item.h.

Constructor & Destructor Documentation

◆ PCB_DRILL_CHART() [1/2]

PCB_DRILL_CHART::PCB_DRILL_CHART ( BOARD_ITEM * aParent )

Definition at line 42 of file pcb_drill_chart.cpp.

References ApplyTemplate(), BOARD_ITEM::BOARD_ITEM(), m_builtGeneration, m_precision, m_showTotals, m_symbolColumn, m_units, DRILL_CHART_TEMPLATE::MakeDefault(), MM, PCB_DRILL_CHART_T, PCB_TABLE::PCB_TABLE(), and pcbIUScale.

Referenced by Clone(), operator=(), operator==(), PCB_DRILL_CHART(), and swapData().

◆ PCB_DRILL_CHART() [2/2]

PCB_DRILL_CHART::PCB_DRILL_CHART ( const PCB_DRILL_CHART & aOther )

Definition at line 54 of file pcb_drill_chart.cpp.

References m_builtGeneration, m_columns, m_filter, m_precision, m_rowKeys, m_rowShapes, m_showTotals, m_symbolColumn, m_units, PCB_DRILL_CHART(), and PCB_TABLE::PCB_TABLE().

◆ ~PCB_DRILL_CHART()

PCB_DRILL_CHART::~PCB_DRILL_CHART ( )

overridedefault

Member Function Documentation

◆ Add()

void PCB_TABLE::Add	(	BOARD_ITEM *	aItem,
		ADD_MODE	aMode = ADD_MODE::INSERT,
		bool	aSkipConnectivity = false )

inlineoverridevirtualinherited

Adds an item to the container.

Parameters

aMode	decides whether the item is added in the beginning or at the end of the list.
aSkipConnectivity	skip connectivity update (useful for file loading, when the connectivity is updated after end of loading).

Implements BOARD_ITEM_CONTAINER.

Definition at line 209 of file pcb_table.h.

References BOARD_ITEM::BOARD_ITEM(), and INSERT.

◆ AddCell()

void PCB_TABLE::AddCell ( PCB_TABLECELL * aCell )

inlineinherited

Definition at line 165 of file pcb_table.h.

References BOARD_ITEM::GetLayer(), m_cells, PCB_SHAPE::SetLayer(), and EDA_ITEM::SetParent().

Referenced by CopyFrom(), Deserialize(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), PCB_TABLE(), and ResizeCells().

◆ ApplyTemplate()

void PCB_DRILL_CHART::ApplyTemplate ( const DRILL_CHART_TEMPLATE & aTemplate )

Copy a template's formatting.

Called when a chart is placed, never afterwards.

Definition at line 71 of file pcb_drill_chart.cpp.

References DRILL_CHART_TEMPLATE::Columns(), DRILL_CHART_TEMPLATE::GetPrecision(), DRILL_CHART_TEMPLATE::GetShowTotals(), DRILL_CHART_TEMPLATE::GetUnits(), m_columns, m_precision, m_showTotals, and m_units.

Referenced by PCB_DRILL_CHART().

◆ Autosize()

void PCB_TABLE::Autosize ( )

inherited

Definition at line 435 of file pcb_table.cpp.

References ARC_LOW_DEF, SHAPE_POLY_SET::BBox(), ERROR_INSIDE, GetCell(), GetColCount(), PCB_TEXTBOX::GetMarginLeft(), PCB_TEXTBOX::GetMarginRight(), GetRowCount(), Normalize(), SetColWidth(), SetRowHeight(), and PCB_TEXTBOX::TransformTextToPolySet().

Referenced by PCB_DRILL_CHART::RebuildCells().

◆ BoardCopperLayerCount()

int BOARD_ITEM::BoardCopperLayerCount ( ) const

virtualinherited

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

Definition at line 203 of file board_item.cpp.

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

Referenced by PAD::ClearZoneLayerOverrides(), PCB_VIA::GetLayerSet(), PAD::PAD(), PCB_VIA::SanitizeLayers(), and PNS_KICAD_IFACE_BASE::syncPad().

◆ BoardLayerCount()

int BOARD_ITEM::BoardLayerCount ( ) const

virtualinherited

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

Definition at line 192 of file board_item.cpp.

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

◆ BoardLayerSet()

LSET BOARD_ITEM::BoardLayerSet ( ) const

virtualinherited

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

Definition at line 214 of file board_item.cpp.

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

Referenced by ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper().

◆ buildGroups()

std::vector< DRILL_CHART_GROUP > PCB_DRILL_CHART::buildGroups ( const BOARD & aBoard ) const

private

The board data this chart reports on, as chart rows.

Definition at line 100 of file pcb_drill_chart.cpp.

References BOARD_ITEM::BOARD, EnumerateDrillSpans(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetDrillSymbolProfile(), DRILL_CHART_ROW_SPEC::m_Filter, m_filter, and model.

Referenced by RebuildCells().

◆ ClassOf()

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

inlinestatic

Definition at line 61 of file pcb_drill_chart.h.

References PCB_DRILL_CHART_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 154 of file eda_item.h.

References BRIGHTENED, and ClearFlags().

Referenced by KICAD_DIFF::ConfigureSchDiffCanvasContext(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PL_SELECTION_TOOL::unhighlight(), SCH_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and PCB_TEST_SELECTION_TOOL::unhighlightInternal().

◆ ClearCells()

void PCB_TABLE::ClearCells ( )

inlineinherited

Definition at line 187 of file pcb_table.h.

References m_cells.

Referenced by CopyFrom(), and Deserialize().

◆ ClearCustomProperties()

void EDA_ITEM::ClearCustomProperties ( )

inlineinherited

Definition at line 270 of file eda_item.h.

References m_customProperties.

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 178 of file eda_item.h.

References ClearFlags(), and GetEditFlags().

Referenced by BOARD::Add(), FOOTPRINT::Add(), LIB_SYMBOL::ClearEditFlags(), DRAWING_TOOL::drawShape(), SCH_MOVE_TOOL::finalizeMoveOperation(), PL_DRAWING_TOOLS::PlaceItem(), BOARD_COMMIT::Push(), SCH_EDIT_FRAME::PutDataInPreviousState(), BOARD_COMMIT::Revert(), SCH_ITEM::SwapFlags(), SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace(), and FOOTPRINT::UpdateFields().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 160 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, m_flags, and m_netHighlighted.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), PNS_KICAD_IFACE_GENERATOR::AddItem(), AlignSchematicItemsToGrid(), SCH_MOVE_TOOL::AlignToGrid(), BACK_ANNOTATE::applyChangelist(), PCB_CONTROL::ApplyDesignBlockLayout(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), FOOTPRINT::BuildCourtyardCaches(), ClearBrightened(), ClearEditFlags(), ClearSelected(), ClearTempFlags(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), MULTICHANNEL_TOOL::copyRuleAreaContents(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), PCB_TOOL_BASE::doInteractiveItemPlacement(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_ITEM::Duplicate(), PCB_TUNING_PATTERN::EditCancel(), PCB_VIA_STACK::EditCancel(), PCB_VIA_STITCH::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_VIA_STACK::EditFinish(), PCB_VIA_STITCH::EditFinish(), BOARD::ExchangeFootprint(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), SCH_IO_KICAD_SEXPR::Format(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), SCH_COLLECTOR::Inspect(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromLibrary(), SCH_IO_PADS::LoadSchematicFile(), SCH_ALIGN_TOOL::moveItem(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), SCH_EASYEDAPRO_PARSER::ParseSchematic(), SCH_EASYEDAPRO_V3_PARSER::ParseSchematic(), PCB_BASE_FRAME::PlaceFootprint(), DRAWING_TOOL::PlaceMicroviaStack(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_MOVE_TOOL::preprocessBreakOrSliceSelection(), SCH_COMMIT::pushSchEdit(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_SELECTION_TOOL::RebuildSelection(), PAD::Recombine(), FOOTPRINT_EDIT_FRAME::RefreshLibraryFootprintTab(), GERBVIEW_FRAME::RemapLayers(), SCH_COMMIT::Revert(), DRC_TEST_PROVIDER_DISALLOW::Run(), ISSUE22864_FIXTURE::RunAlignmentAndVerify(), ISSUE22864_FIXTURE::RunAlignmentAndVerifyNoSkew(), FOOTPRINT_EDIT_FRAME::SaveFootprintInLibrary(), HEADLESS_FOOTPRINT_CONTEXT::SaveFootprintInLibrary(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_IO_KICAD_SEXPR_LIB_CACHE::savePin(), SCH_SELECTION_TOOL::SelectMultiple(), SetIsShownAsBitmap(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_SELECTION_TOOL::unhighlight(), SCH_SHAPE::UpdateHatching(), and SCOPED_FLAGS_CLEANER::~SCOPED_FLAGS_CLEANER().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 191 of file eda_item.h.

References ClearFlags(), and GetTempFlags().

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

◆ Clone()

EDA_ITEM * PCB_DRILL_CHART::Clone ( ) const

inlineoverridevirtual

Create a duplicate of this item with linked list members set to NULL.

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 68 of file pcb_drill_chart.h.

References PCB_DRILL_CHART().

Referenced by BOOST_AUTO_TEST_CASE().

◆ Columns() [1/2]

std::vector< DRILL_CHART_COLUMN > & PCB_DRILL_CHART::Columns ( )

inline

Definition at line 73 of file pcb_drill_chart.h.

References m_columns.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and PCB_IO_KICAD_SEXPR::format().

◆ Columns() [2/2]

const std::vector< DRILL_CHART_COLUMN > & PCB_DRILL_CHART::Columns ( ) const

inline

Definition at line 74 of file pcb_drill_chart.h.

References m_columns.

◆ Compare()

int PCB_TABLE::Compare	(	const PCB_TABLE *	aTable,
		const PCB_TABLE *	aOther )

staticinherited

Definition at line 920 of file pcb_table.cpp.

References GetCell(), GetCells(), GetColCount(), GetColWidth(), GetRowCount(), GetRowHeight(), and PCB_TABLE().

Referenced by BOARD::cmp_drawings::operator()().

◆ CopyFrom()

void PCB_TABLE::CopyFrom ( const BOARD_ITEM * aOther )

overridevirtualinherited

Reimplemented from BOARD_ITEM.

Definition at line 94 of file pcb_table.cpp.

References AddCell(), BOARD_ITEM::BOARD_ITEM(), ClearCells(), PCB_TABLECELL::Clone(), BOARD_ITEM::CopyFrom(), m_borderStroke, m_cells, m_colCount, m_colWidths, m_rowHeights, m_separatorsStroke, m_strokeColumns, m_strokeExternal, m_StrokeHeaderSeparator, m_strokeRows, PCB_TABLE(), PCB_TABLE_T, and EDA_ITEM::Type().

◆ Delete()

virtual void BOARD_ITEM_CONTAINER::Delete ( BOARD_ITEM * aItem )

inlinevirtualinherited

Removes an item from the container and deletes it.

Definition at line 72 of file board_item_container.h.

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

◆ DeleteMarkedCells()

void PCB_TABLE::DeleteMarkedCells ( )

inlineinherited

Definition at line 195 of file pcb_table.h.

References EDA_ITEM::GetFlags(), m_cells, and STRUCT_DELETED.

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 303 of file board_item.cpp.

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

◆ Deserialize()

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

overridevirtual

Deserializes the given protobuf message into this object.

Parameters

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

Returns: true if unpacking and deserialization succeeded

Reimplemented from SERIALIZABLE.

Definition at line 682 of file pcb_drill_chart.cpp.

References PCB_TABLE::Deserialize(), DRILL_CHART_MAX_COLUMN_WIDTH, DrillDocumentationLayers(), BOARD_ITEM::GetLayer(), INCH, DRILL_CHART_COLUMN::m_Align, m_columns, m_filter, DRILL_CHART_COLUMN::m_Heading, DRILL_CHART_COLUMN::m_Id, m_rowKeys, m_rowShapes, m_showTotals, m_symbolColumn, m_units, DRILL_CHART_COLUMN::m_Width, MM, pcbIUScale, SetPrecision(), kiapi::common::UnpackDistance(), and ValidateDrillChartColumns().

Referenced by BOOST_FIXTURE_TEST_CASE().

◆ DisambiguateItemDescription()

virtual wxString EDA_ITEM::DisambiguateItemDescription	(	UNITS_PROVIDER *	aUnitsProvider,
		bool	aFull ) const

inlinevirtualinherited

Reimplemented in FOOTPRINT.

Definition at line 456 of file eda_item.h.

References GetItemDescription().

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ DrawBorders()

void PCB_TABLE::DrawBorders ( const std::function< void(const VECTOR2I &aPt1, const VECTOR2I &aPt2, const STROKE_PARAMS &aStroke)> & aCallback ) const

inherited

◆ Duplicate()

BOARD_ITEM * PCB_TABLE::Duplicate	(	bool	addToParentGroup,
		BOARD_COMMIT *	aCommit = nullptr ) const

overridevirtualinherited

Create a copy of this BOARD_ITEM.

Parameters

addToParentGroup Indicates whether or not the new item is added to the group containing the old item. If true, aCommit must be provided.

Reimplemented from BOARD_ITEM.

Definition at line 120 of file pcb_table.cpp.

References BOARD_ITEM::BOARD_ITEM(), Clone(), EDA_ITEM::GetParentGroup(), group, COMMIT::Modify(), NO_RECURSE, BOARD_ITEM::ResetUuid(), and BOARD_ITEM::RunOnChildren().

◆ Filter() [1/2]

DRILL_CHART_FILTER & PCB_DRILL_CHART::Filter ( )

inline

Definition at line 70 of file pcb_drill_chart.h.

References m_filter.

Referenced by PCB_IO_KICAD_SEXPR::format().

◆ Filter() [2/2]

const DRILL_CHART_FILTER & PCB_DRILL_CHART::Filter ( ) const

inline

Definition at line 71 of file pcb_drill_chart.h.

References m_filter.

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 137 of file eda_item.cpp.

References EDA_ITEM(), GetParent(), and Type().

Referenced by BOARD_ITEM::GetBoard(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetParentFootprint(), SCH_ITEM::GetParentSymbol(), SCH_ITEM::GetParentSymbol(), and SCH_ITEM::Schematic().

◆ FitsEnabledLayers()

bool BOARD_ITEM::FitsEnabledLayers	(	const LSET &	aEnabledLayers,
		int	aCopperLayerCount ) const

virtualinherited

Check if a board offering aEnabledLayers can hold this item.

A layer-agnostic item always fits; anything else needs at least one of its own layers enabled. aCopperLayerCount is passed rather than read from the item because the item may still belong to the board it is being copied from.

Reimplemented in FOOTPRINT, and PCB_VIA.

Definition at line 37 of file board_item.cpp.

References GetLayerSet(), and IsLayerAgnostic().

Referenced by BOOST_AUTO_TEST_CASE(), and PCB_VIA::FitsEnabledLayers().

◆ Flip()

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

overridevirtualinherited

Flip this object, i.e.

change the board side for this object.

Parameters

aCentre	the rotation point.
aFlipDirection	the flip direction

Reimplemented from BOARD_ITEM.

Definition at line 517 of file pcb_table.cpp.

References ANGLE_0, FlipLayer(), BOARD_ITEM::GetBoard(), BOX2< Vec >::GetBottom(), GetBoundingBox(), GetColCount(), BOARD_ITEM::GetLayer(), BOX2< Vec >::GetLeft(), BOARD_ITEM::GetParentFootprint(), BOX2< Vec >::GetPosition(), GetPosition(), BOX2< Vec >::GetRight(), GetRowCount(), BOX2< Vec >::GetTop(), LEFT_RIGHT, m_cells, m_colWidths, Move(), Normalize(), Rotate(), SetLayer(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Mirror().

◆ Get() [1/3]

template<typename T>

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

inherited

Definition at line 84 of file inspectable_impl.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

◆ Get() [3/3]

template<typename T>

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

Definition at line 72 of file inspectable_impl.h.

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

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 95 of file board_item.cpp.

References BOARD, EDA_ITEM::findParent(), 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 86 of file board_item.cpp.

References BOARD, EDA_ITEM::findParent(), PCB_T, and EDA_ITEM::Type().

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::Add(), COMPONENTS_MANAGER::AddComponent(), BOARD_ADAPTER::addShape(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), PCB_BARCODE::AssembleBarcode(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BoardCopperLayerCount(), BoardLayerCount(), BoardLayerSet(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CN_CONNECTIVITY_ALGO::Build(), FOOTPRINT::BuildNetTieCache(), ZONE::BuildSmoothedPoly(), ZONE::CacheBoundingBox(), TMATCH::checkCandidateNetConsistency(), collidesWithArea(), ConstraintItemIsLocked(), PG_NET_SELECTOR_EDITOR::CreateControls(), PCB_TUNING_PATTERN::CreateNew(), FOOTPRINT::DeserializeDefinition(), PCB_GROUP::DeserializeGroup(), BOARD_INSPECTION_TOOL::DiffFootprint(), DIMENSION_DESC::DIMENSION_DESC(), doIntersectsAreaFunc(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::drawChartSymbols(), KIGFX::PCB_PAINTER::drawDrillMarks(), KIGFX::PCB_PAINTER::drawDrillSymbol(), ZONE::Duplicate(), enclosedByAreaFunc(), existsOnLayerFunc(), ZONE_FILLER::Fill(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), PAD::FlashLayer(), PCB_VIA::FlashLayer(), FOOTPRINT::Flip(), PAD::Flip(), PCB_ARC::Flip(), PCB_BARCODE::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_DRILL_MAP::Flip(), PCB_GENERATOR::Flip(), PCB_POINT::Flip(), PCB_REFERENCE_IMAGE::Flip(), PCB_SHAPE::Flip(), PCB_TABLE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), PCB_VIA::Flip(), PCB_VIA_STACK::Flip(), ZONE::Flip(), FOOTPRINT::FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), fromToFunc(), PCB_DRILL_MAP::GetBoardOutlines(), FOOTPRINT::GetBoundingBox(), NETINFO_ITEM::GetBoundingBox(), PCB_DRILL_MAP::GetBoundingBox(), ZONE::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), FOOTPRINT::GetBoundingHull(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TRACK::GetDelay(), BOARD_CONNECTED_ITEM::GetDisplayNetname(), PCB_VIA::GetDrillConstraint(), FOOTPRINT::GetDynamicProperties(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), GetEmbeddedFonts(), getFieldFunc(), PCB_VIA_STITCH::GetGuardedNetCode(), PCB_SHAPE::getHatchingKnockouts(), ZONE::GetInteractingZones(), PAD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), ZONE::GetItemDescription(), PCB_PROPERTIES_PANEL::getItemValue(), FOOTPRINT::GetLayerBoundingBox(), GetLayerName(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::getLiveFieldValueForVariant(), GetMaxError(), PCB_VIA::GetMinAnnulus(), FOOTPRINT::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), PCB_VIA_STITCH::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), PCB_VIA::GetOutermostConnectedLayers(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetPostMachiningKnockout(), PCB_VIA::GetPostMachiningKnockout(), PCB_TUNING_PATTERN::GetPreviewItems(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_MARKER::GetSeverity(), PCB_FIELD::GetShownText(), PCB_TABLECELL::GetShownText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), FOOTPRINT::GetSide(), PAD::GetSolderMaskExpansion(), PCB_SHAPE::GetSolderMaskExpansion(), PCB_TRACK::GetSolderMaskExpansion(), PCB_VIA::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), PCB_DRILL_MAP::GetSpanChoice(), PCB_DRILL_MAP::GetSymbolExtent(), PCB_FOOTPRINT_FIELD_PROPERTY::getter(), BOARD::GetTrackLength(), PCB_DIMENSION_BASE::GetValueFieldText(), PCB_DIMENSION_BASE::GetValueMode(), DIALOG_FIND_BY_PROPERTIES::getVariantAwareValue(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), PCB_VIA_STITCH::GetZonesNeedingRefillAfterUpdate(), hasExactNetclassFunc(), hasNetChainFunc(), PCB_DRILL_MAP::HitTest(), inDiffPairFunc(), inNetChainClassFunc(), inNetChainFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), PAD::IsBackdrilledOrPostMachined(), PCB_VIA::IsBackdrilledOrPostMachined(), isCoupledDiffPairFunc(), PCB_VIA::IsGhostLayer(), IsLocked(), IsSideSpecific(), PCB_VIA::IsTented(), LayerMaskDescribe(), PCB_VIA::LayerMaskDescribe(), ZONE::Move(), CN_VISITOR::operator()(), FOOTPRINT::operator=(), FOOTPRINT::operator=(), PCB_IO_EAGLE::packageWire(), padNeedsUpdate(), PartitionNetChainAroundNet(), PCB_DRILL_MAP::PCB_DRILL_MAP(), ZONE_PAINTER::PCB_PAINTER(), PCB_DRAW_PANEL_GAL::prepareGridSources(), SPRINT_LAYOUT_PARSER::processCircle(), SPRINT_LAYOUT_PARSER::processLine(), SPRINT_LAYOUT_PARSER::processPad(), SPRINT_LAYOUT_PARSER::processPoly(), PCB_TUNING_PATTERN::recoverBaseline(), FOOTPRINT::Remove(), BOARD::ResolveDRCExclusions(), FOOTPRINT::ResolveTextVar(), FOOTPRINT::ResolveTextVar(), FOOTPRINT::Serialize(), PCB_ARC::Serialize(), PCB_BARCODE::Serialize(), PCB_DIMENSION_BASE::Serialize(), PCB_GROUP::Serialize(), PCB_POINT::Serialize(), PCB_REFERENCE_IMAGE::Serialize(), PCB_SHAPE::Serialize(), PCB_TABLE::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TRACK::Serialize(), PCB_VIA::Serialize(), ZONE::Serialize(), PAD::SetAttribute(), PCB_VIA::SetBottomLayer(), PCB_VIA_STITCH::SetGuardedNetCode(), PCB_SHAPE::SetIsProxyItem(), BOARD_CONNECTED_ITEM::SetLayer(), PCB_VIA::SetLayerPair(), PAD::SetLayerSet(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_TUNING_PATTERN::SetNetCode(), PCB_VIA_STITCH::SetNetCode(), PCB_DRILL_MAP::SetSpanChoice(), PCB_FOOTPRINT_FIELD_PROPERTY::setter(), PCB_VIA::SetTopLayer(), PCB_DIMENSION_BASE::SetUnitsMode(), PCB_FIELDS_GRID_TABLE::SetValueAsLong(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), PCB_VIA_STACK::ShowPropertiesDialog(), PCB_VIA_STITCH::ShowPropertiesDialog(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), SwapItemData(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), BOARD_CONNECTED_ITEM::UnpackNet(), ZONE_PRIORITY_CONTEXT_MENU::update(), BOARD::UpdateRatsnestExclusions(), PCB_PROPERTIES_PANEL::valueChanged(), FOOTPRINT::ViewBBox(), PAD::ViewBBox(), PCB_TRACK::ViewBBox(), PAD::ViewGetLayers(), PCB_VIA::ViewGetLayers(), PAD::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_VIA::ViewGetLOD(), ZONE::ZONE(), and zoneNeedsUpdate().

◆ GetBorderColor()

COLOR4D PCB_TABLE::GetBorderColor ( ) const

inlineinherited

Definition at line 81 of file pcb_table.h.

References m_borderStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ GetBorderStroke()

const STROKE_PARAMS & PCB_TABLE::GetBorderStroke ( ) const

inlineinherited

Definition at line 66 of file pcb_table.h.

References m_borderStroke.

Referenced by DrawBorders(), PCB_IO_KICAD_SEXPR::formatTableData(), and TransformShapeToPolygon().

◆ GetBorderStyle()

LINE_STYLE PCB_TABLE::GetBorderStyle ( ) const

inlineinherited

Definition at line 72 of file pcb_table.h.

References DEFAULT, m_borderStroke, and SOLID.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ GetBorderWidth()

int PCB_TABLE::GetBorderWidth ( ) const

inlineinherited

Definition at line 69 of file pcb_table.h.

References m_borderStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ GetBoundingBox()

const BOX2I PCB_TABLE::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 650 of file pcb_table.cpp.

References m_cells, and BOX2< Vec >::Merge().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), checkTableSane(), Flip(), HitTest(), HitTest(), and PCB_CONTROL::PlaceDrillChart().

◆ GetBuiltGeneration()

uint64_t PCB_DRILL_CHART::GetBuiltGeneration ( ) const

inline

Board drill generation the cells were built at.

A chart is derived data, so anything that reads it refreshes it first and this is the cheap test for whether it has to.

Definition at line 94 of file pcb_drill_chart.h.

References m_builtGeneration.

Referenced by BOOST_AUTO_TEST_CASE(), and RefreshDrillCharts().

◆ GetCell()

PCB_TABLECELL * PCB_TABLE::GetCell	(	int	aRow,
		int	aCol ) const

inlineinherited

Definition at line 150 of file pcb_table.h.

References m_cells, and m_colCount.

Referenced by Autosize(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compare(), DrawBorders(), KIGFX::PCB_PAINTER::drawChartSymbols(), PCB_EDIT_TABLE_TOOL::ExportTableToCSV(), GetEffectiveShape(), Normalize(), BRDITEMS_PLOTTER::PlotChartSymbols(), and PCB_DRILL_CHART::RebuildCells().

◆ GetCells()

std::vector< PCB_TABLECELL * > PCB_TABLE::GetCells ( ) const

inlineinherited

◆ GetCenter()

virtual VECTOR2I BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

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

Returns: center point of the item

Reimplemented in FOOTPRINT, PAD, PCB_ARC, PCB_BARCODE, PCB_MARKER, and PCB_SHAPE.

Definition at line 150 of file board_item.h.

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

Referenced by PCB_GRID_HELPER::computeAnchors(), PCB_SELECTION_TOOL::FindItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::resolveSilkDisposition().

◆ GetClass()

wxString PCB_DRILL_CHART::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from PCB_TABLE.

Definition at line 66 of file pcb_drill_chart.h.

◆ GetColCount()

int PCB_TABLE::GetColCount ( ) const

inlineinherited

Definition at line 121 of file pcb_table.h.

References m_colCount.

Referenced by Autosize(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compare(), DrawBorders(), PCB_EDIT_TABLE_TOOL::ExportTableToCSV(), Flip(), PCB_IO_KICAD_SEXPR::formatTableData(), GetEffectiveShape(), GetEnd(), PCB_DRILL_CHART::migrateRows(), and Normalize().

◆ GetColWidth()

int PCB_TABLE::GetColWidth ( int aCol ) const

inlineinherited

Definition at line 132 of file pcb_table.h.

References m_colWidths.

Referenced by Compare(), PCB_IO_KICAD_SEXPR::formatTableData(), GetEnd(), PCB_DRILL_CHART::RebuildCells(), and Serialize().

◆ GetCustomProperties()

const std::map< wxString, wxString > & EDA_ITEM::GetCustomProperties ( ) const

inlineinherited

Custom user-defined string key/value properties attached to this item.

Keys and values are arbitrary strings; their meaning is defined by the user. The only constraint is that keys may not duplicate a built-in property (or field name, for items that have fields).

Definition at line 242 of file eda_item.h.

References m_customProperties.

Referenced by BOOST_AUTO_TEST_CASE(), KICAD_FORMAT::FormatCustomProperties(), and kiapi::common::PackCustomProperties().

◆ GetCustomPropertiesAsInspectables()

std::vector< PROPERTY_BASE * > EDA_ITEM::GetCustomPropertiesAsInspectables ( ) const

inherited

Definition at line 200 of file eda_item.cpp.

References m_customProperties, m_dynamicCustomPropsCache, and TYPE_HASH.

Referenced by GetDynamicProperties(), FOOTPRINT::GetDynamicProperties(), SCH_SHEET::GetDynamicProperties(), and SCH_SYMBOL::GetDynamicProperties().

◆ GetCustomProperty()

bool EDA_ITEM::GetCustomProperty	(	const wxString &	aKey,
		wxString &	aValue ) const

inherited

Returns: true if aKey is present and aValue was filled

Definition at line 188 of file eda_item.cpp.

References m_customProperties.

Referenced by customPropertyFunc(), EDA_CUSTOM_PROPERTY::getter(), hasCustomPropertyFunc(), PCB_PROPERTIES_PANEL::onKeyRenamed(), and SCH_PROPERTIES_PANEL::onKeyRenamed().

◆ GetDynamicProperties()

std::vector< PROPERTY_BASE * > EDA_ITEM::GetDynamicProperties ( ) const

overridevirtualinherited

Return dynamically-computed properties specific to this object instance (e.g.

custom fields, pin-map entries). These are NOT registered in PROPERTY_MANAGER and do NOT appear in GetProperties(TYPE_ID).

The returned PROPERTY_BASE* pointers are owned by the object and remain valid until the object is destroyed or its property set changes.

Reimplemented from INSPECTABLE.

Reimplemented in FOOTPRINT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 226 of file eda_item.cpp.

References GetCustomPropertiesAsInspectables().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveHoleShape()

std::shared_ptr< SHAPE_SEGMENT > BOARD_ITEM::GetEffectiveHoleShape	(	PCB_LAYER_ID	aLayer = UNDEFINED_LAYER,
		DRC_CONSTRAINT_T	aUsage = NULL_CONSTRAINT ) const

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 405 of file board_item.cpp.

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

Referenced by collidesWithArea(), DRC_RTREE::Insert(), ItemHasDRCViolation(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_HOLE_TO_HOLE::testHoleAgainstHole(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > PCB_TABLE::GetEffectiveShape	(	PCB_LAYER_ID	aLayer = UNDEFINED_LAYER,
		FLASHING	aFlash = FLASHING::DEFAULT,
		DRC_CONSTRAINT_T	aUsage = NULL_CONSTRAINT ) const

overridevirtualinherited

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

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

Note: This list can contain a SHAPE_SIMPLE (a simple single-outline non-intersecting polygon), but should never contain a SHAPE_POLY_SET (a complex polygon consisting of multiple outlines and/or holes).

Parameters

aLayer	in case of items spanning multiple layers, only the shapes belonging to aLayer will be returned. Pass UNDEFINED_LAYER to return shapes for all layers.
aFlash	optional parameter allowing a caller to force the pad to be flashed (or not flashed) on the current layer (default is to honour the pad's setting and the current connections for the given layer).
aUsage	optional parameter specifying the query type. This can, for instance, allow backdrilling, countersinking, etc. to affect the shape used for resolving the physical_clearance.

Reimplemented from BOARD_ITEM.

Definition at line 744 of file pcb_table.cpp.

References DrawBorders(), GetCell(), GetColCount(), PCB_TEXTBOX::GetCornersInSequence(), EDA_TEXT::GetDrawRotation(), GetRowCount(), and STROKE_PARAMS::GetWidth().

Referenced by HitTest().

◆ GetEmbeddedFiles()

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )

inlinevirtualinherited

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

Definition at line 549 of file eda_item.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::Parse().

◆ GetEmbeddedFonts()

const std::vector< wxString > * BOARD_ITEM::GetEmbeddedFonts ( )

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 460 of file board_item.cpp.

References BOARD, and GetBoard().

◆ GetEnd()

VECTOR2I PCB_TABLE::GetEnd ( ) const

inherited

Definition at line 317 of file pcb_table.cpp.

References GetColCount(), GetColWidth(), GetPosition(), GetRowCount(), GetRowHeight(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 167 of file eda_item.h.

References m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), checkCourtyardCloses(), collidesWithArea(), PCB_TABLE::DeleteMarkedCells(), SCH_TABLE::DeleteMarkedCells(), doConvertOutlineToPolygon(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), doIntersectsAreaFunc(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::EditCancel(), PCB_VIA_STITCH::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), PCB_VIA_STITCH::EditFinish(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::FilterCollectorForHierarchy(), findNext(), DRC_ITEM::GetViolationLayers(), hasExactNetclassFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD::Recombine(), DRC_TEST_PROVIDER_CONNECTIVITY::Run(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), PAD::SetAttribute(), PCB_VIA::SetBottomLayer(), BOARD_CONNECTED_ITEM::SetLayer(), PCB_VIA::SetLayerPair(), PAD::SetLayerSet(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_VIA::SetTopLayer(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), PCB_TUNING_PATTERN::Update(), PCB_VIA_STACK::Update(), and PCB_VIA_STITCH::Update().

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_ARC, PCB_SHAPE, and PCB_TRACK.

Definition at line 355 of file eda_item.h.

References GetPosition().

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

◆ GetFontMetrics()

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

inherited

Definition at line 169 of file board_item.cpp.

References KIFONT::METRICS::Default().

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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 167 of file view_item.h.

References m_forcedTransparency.

Referenced by KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::getRenderColor(), EDA_ITEM::operator=(), ZONE_PAINTER::PCB_PAINTER(), and LIB_SYMBOL::SetParent().

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 415 of file board_item.cpp.

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

Referenced by PCB_IO_IPC2581::addLocationNode(), PCB_IO_IPC2581::addPackage(), EDA_DATA::PACKAGE::AddPin(), CHECK_SHAPE_LIBPOS_MIRROR(), PCB_IO_KICAD_SEXPR::format(), PCB_FIELDS_GRID_TABLE::GetValue(), FOOTPRINT::cmp_drawings::operator()(), FOOTPRINT::cmp_pads::operator()(), padNeedsUpdate(), processTextItem(), and PCB_FIELDS_GRID_TABLE::SetValue().

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TABLECELL, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA_STACK, PCB_VIA_STITCH, SCH_DIRECTIVE_LABEL, SCH_FIELD, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, SCH_PIN, SCH_RULE_AREA, SCH_SHEET_PIN, SCH_TEXT, and ZONE.

Definition at line 565 of file eda_item.cpp.

References GetTypeDesc().

Referenced by API_HANDLER_BOARD::createItemForType(), API_HANDLER_SCH::createItemForType(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), and PROPERTIES_PANEL::rebuildProperties().

◆ GetItemDescription()

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

overridevirtual

Return a user-visible description string of this item.

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

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

Parameters

aLong indicates a long string is acceptable

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 276 of file pcb_drill_chart.cpp.

References _, and PCB_TABLE::GetRowCount().

◆ GetLayer()

PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

virtualinherited

Return the primary layer this item is on.

Reimplemented in BOARD, BOARD_CONNECTED_ITEM, FOOTPRINT, NETINFO_ITEM, PAD, PCB_BOARD_OUTLINE, PCB_GENERATOR, PCB_GRID_ITEM, PCB_GROUP, PCB_SHAPE, PCB_TUNING_PATTERN, PCB_VIA, and ZONE.

Definition at line 184 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass(), IsSingleLayerType(), m_layer, and EDA_ITEM::Type().

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

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

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PAD, PCB_BOARD_OUTLINE, PCB_GENERATOR, PCB_GRID_ITEM, PCB_GROUP, PCB_SHAPE, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 346 of file board_item.h.

References m_layer, and UNDEFINED_LAYER.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), collidesWithArea(), PCB_GRID_HELPER::computeAnchors(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), doIntersectsAreaFunc(), KIGFX::PCB_PAINTER::Draw(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), existsOnLayerFunc(), FindSnapGraphic(), FindSnapPad(), FindSnapTrack(), FitsEnabledLayers(), LAYER_UTILS::GetAllFootprintLayers(), getBoardNormalizedLayerSet(), hash_board_item(), PNS_KICAD_IFACE::IsItemVisible(), isMaskAperture(), IsOnCopperLayer(), IsSideSpecific(), ItemHasDRCViolation(), LayerMaskDescribe(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), BOARD_ITEM::ptr_cmp::operator()(), CN_VISITOR::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), ZONE_PAINTER::PCB_PAINTER(), DRC_ENGINE::ProcessAssertions(), BOARD_COMMIT::propagateDamage(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), BOARD::RemoveAllItemsOnLayer(), BOARD_INSPECTION_TOOL::reportClearance(), PCB_GRID_HELPER::ResolveSnap(), PCB_GRID_HELPER::ResolveSnap(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), ITEM_EVAL_EXPECTATION::RunTest(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), SCOPED_LAYERSET::SCOPED_LAYERSET(), POINT_PLACER::SnapItem(), stackupNeedsUpdate(), GLOBAL_EDIT_TOOL::swapBoardItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), FOOTPRINT_EDIT_FRAME::updateEnabledLayers(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetMaxError()

int BOARD_ITEM::GetMaxError ( ) const

inherited

Definition at line 175 of file board_item.cpp.

References ARC_HIGH_DEF, BOARD, and GetBoard().

Referenced by STEP_PCB_MODEL::AddPadShape(), BOARD_ADAPTER::addShape(), BOARD_ADAPTER::addShape(), PCB_IO_IPC2581::addShape(), BOARD_ADAPTER::addText(), DSN::appendPadstackShape(), PAD::BuildEffectivePolygon(), PAD::buildEffectiveShape(), EXPORTER_STEP::buildFootprint3DShapes(), EXPORTER_STEP::buildGraphic3DShape(), ZONE::BuildSmoothedPoly(), EXPORTER_STEP::buildTrack3DShape(), FOOTPRINT::CheckNetTies(), PCB_BARCODE::ComputeTextPoly(), BOARD_ADAPTER::createLayers(), CONVERT_TOOL::CreateLines(), BOARD_ADAPTER::createPadWithMargin(), BOARD_ADAPTER::createTrackWithMargin(), PAD::doCheckPad(), KIGFX::PCB_PAINTER::draw(), PCB_TEXT::GetEffectiveShape(), PCB_SHAPE::getMaxError(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), PAD::MergePrimitivesAsPolygon(), BRDITEMS_PLOTTER::PlotShape(), process(), processClosedShape(), OUTSET_ROUTINE::ProcessItem(), CONSTRAINT_OVERLAY::render(), PNS_KICAD_IFACE_BASE::syncBarcode(), PNS_KICAD_IFACE_BASE::syncDimension(), PNS_KICAD_IFACE_BASE::syncTextItem(), ZONE::TransformSmoothedOutlineToPolygon(), and GENCAD_EXPORTER::writePadShape().

◆ GetMenuImage()

BITMAPS PCB_TABLE::GetMenuImage ( ) const

overridevirtualinherited

Return a pointer to an image to be used in menus.

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

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 878 of file pcb_table.cpp.

References table.

◆ GetMsgPanelInfo()

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

overridevirtual

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

Parameters

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

Reimplemented from EDA_ITEM.

Definition at line 282 of file pcb_drill_chart.cpp.

References _, BOARD_ITEM::GetLayerName(), and PCB_TABLE::GetRowCount().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( ) const

inlineinherited

Definition at line 266 of file board_item.h.

References EDA_ITEM::m_parent.

Referenced by BOOST_AUTO_TEST_CASE(), ZONE::Clone(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createTrackWithMargin(), EDIT_TOOL::DeleteItems(), DeleteStructure(), KICAD_DIFF::PCB_DIFFER::diffProperties(), doIntersectsAreaFunc(), KIGFX::PCB_PAINTER::draw(), enclosedByAreaFunc(), PCB_SELECTION_TOOL::extendTableCellSelectionTo(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), PCB_SHAPE::Flip(), getClosestGroup(), PCB_TABLECELL::GetColumn(), PCB_TABLECELL::GetColumnWidth(), PCB_SHAPE::GetLibraryBezierC1(), PCB_SHAPE::GetLibraryBezierC2(), PCB_SHAPE::GetLibraryPolyShape(), PCBEXPR_VAR_REF::GetObject(), PCB_TABLECELL::GetParentGroup(), PCB_TABLECELL::GetRow(), PCB_TABLECELL::GetRowHeight(), DRC_RTREE::Insert(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), KICAD_DIFF::PCB_DIFFER::itemRefdes(), memberOfGroupFunc(), EDIT_TOOL::MoveExact(), moveSelectionBy(), PAD::operator==(), PAD::PAD(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_BOARD_OUTLINE::PCB_BOARD_OUTLINE(), PCB_FIELD::PCB_FIELD(), PCB_FIELD::PCB_FIELD(), PCB_TABLECELL_DESC::PCB_TABLECELL_DESC(), PCB_VIA::PCB_VIA(), BRDITEMS_PLOTTER::PlotBarCode(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), SPRINT_LAYOUT_PARSER::resolveGroups(), PCB_GRID_HELPER::ResolveSnap(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), ITEM_EVAL_EXPECTATION::RunTest(), PCB_TABLECELL::SetColumnWidth(), PCB_TABLECELL::SetRowHeight(), PAD::Similarity(), PCB_BOARD_OUTLINE::Similarity(), SwapItemData(), PCB_SHAPE::syncLibCoords(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), PCB_SELECTION_TOOL::toggleTableCellSelection(), PCB_SHAPE::transformFp(), KIGFX::PCB_VIEW::Update(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ GetParentAsString()

wxString BOARD_ITEM::GetParentAsString ( ) const

inherited

For "parent" property.

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

Definition at line 451 of file board_item.cpp.

References EDA_ITEM::m_parent.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ GetParentFootprint()

FOOTPRINT * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 112 of file board_item.cpp.

References EDA_ITEM::findParent(), and PCB_FOOTPRINT_T.

Referenced by CN_CONNECTIVITY_ALGO::Add(), PCB_IO_IPC2581::addPad(), FEATURES_MANAGER::AddPadShape(), STEP_PCB_MODEL::AddPadShape(), PCB_CONTROL::AppendBoard(), PCB_IO_KICAD_SEXPR_PARSER::bakeTextBoxLib(), BOOST_FIXTURE_TEST_CASE(), PCB_GROUP_TOOL::canGroupItem(), CHAIN_TOPOLOGY::CHAIN_TOPOLOGY(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), collidesWithArea(), ZONE::computeBoundingBox(), computeConstraint(), PCB_BARCODE::ComputeTextPoly(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), ConstraintItemIsLocked(), CONVERT_TOOL::CreatePolys(), customPropertyFunc(), EDIT_TOOL::DeleteItems(), PCB_BARCODE::Deserialize(), doPushPadProperties(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), EDIT_TOOL::Duplicate(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), findOverlappingPairs(), MULTICHANNEL_TOOL::fixupNet(), PAD::Flip(), PCB_BARCODE::Flip(), PCB_POINT::Flip(), PCB_TABLE::Flip(), PCB_TEXT::Flip(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_IPC2581::generateLayerSetNet(), PCB_BARCODE::GetAngle(), ZONE::GetBoardOutline(), PAD::GetClearanceOverrides(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TEXT::GetDrawRotation(), ZONE::GetEffectiveShape(), PCB_DIMENSION_BASE::GetEnd(), GetFPRelativePosition(), PCB_SHAPE::getHatchingKnockouts(), ZONE::GetHatchLines(), ZONE::GetInteractingZones(), PAD::GetItemDescription(), PCB_FIELD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TEXT::GetItemDescription(), PCB_SHAPE::GetMenuImage(), PCB_BARCODE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PAD::GetOffset(), PAD::GetOrientation(), PAD::GetPosition(), PCB_BARCODE::GetPosition(), PAD::GetPrimaryDrillSize(), PAD::GetPrimitiveLibScale(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_FIELD::GetShownText(), PCB_TABLECELL::GetShownText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), PAD::GetSize(), PAD::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), PCB_DIMENSION_BASE::GetStart(), PCB_TEXT::GetTextAngle(), PCB_TEXTBOX::GetTextAngle(), PCB_TEXT::GetTextPos(), PCB_TEXT::GetTextSize(), PCB_TEXTBOX::GetTextSize(), PCB_TEXT::GetTextThickness(), PCB_TEXTBOX::GetTextThickness(), PCB_FIELDS_GRID_TABLE::GetValue(), PCBEXPR_COMPONENT_CLASS_REF::GetValue(), PCBEXPR_VAR_REF::GetValue(), PAD::GetZoneConnectionOverrides(), PCB_SELECTION_TOOL::grabUnconnected(), hasComponentClassFunc(), hasCustomPropertyFunc(), hash_fp_item(), BOARD::HasItemsOnLayer(), PCB_SELECTION_TOOL::HasLockedDescendant(), ZONE::HitTestCutout(), ZONE::HitTestFilledArea(), ZONE::HitTestForCorner(), ZONE::HitTestForEdge(), PAD::ImportSettingsFrom(), GENERAL_COLLECTOR::Inspect(), PCB_SHAPE::IsConnected(), CONNECTIVITY_DATA::IsConnectedOnLayer(), PAD::IsFlipped(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), PNS_PCBNEW_RULE_RESOLVER::IsKeepout(), DRC_ENGINE::IsNetTieExclusion(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), ItemHasDRCViolation(), PCB_SELECTION_TOOL::itemPassesFilter(), DRC_TEST_PROVIDER_SOLDER_MASK::maskApertureBridgeExcluded(), memberOfFootprintFunc(), memberOfSheetFunc(), memberOfSheetOrChildrenFunc(), PCB_DIMENSION_BASE::Mirror(), ZONE::Mirror(), BOARD::Move(), PCB_BARCODE::Move(), PCB_DIMENSION_BASE::Move(), ZONE::Move(), ZONE::MoveEdge(), PCB_TEXT::Offset(), PCB_GRID_HELPER::OnBoardItemRemoved(), ARRAY_TOOL::onDialogClosed(), PAD::OnFootprintTransformed(), PCB_TEXTBOX::OnFootprintTransformed(), PCB_EDIT_FRAME::onVariantSelected(), LENGTH_DELAY_CALCULATION::optimiseVias(), padNeedsUpdate(), PCB_IO_IPC2581::pinName(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), BRDITEMS_PLOTTER::PlotTableBorders(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BOARD_COMMIT::Push(), PAD_TOOL::pushPadSettings(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), PAD::rebakePrimitiveToFootprint(), PAD::Recombine(), PCB_POINT::recomputePosition(), DRC_TEST_PROVIDER_SOLDER_MASK::recordMaskAperture(), refOfSolid(), BOARD::RemoveAllItemsOnLayer(), DRC_TEST_PROVIDER_SOLDER_MASK::reportMaskApertureBridges(), PCB_IO_KICAD_SEXPR_PARSER::resolveConstraints(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), PCB_GRID_HELPER::ResolveSnap(), BOARD_COMMIT::Revert(), PCB_BARCODE::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXTBOX::Rotate(), ZONE::Rotate(), DRC_CACHE_GENERATOR::Run(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PAD::SameLogicalPadAs(), CLIPBOARD_IO::SaveSelection(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_SELECTION_TOOL::Selectable(), PCB_EDIT_FRAME::SendCrossProbeItem(), PAD::Serialize(), PCB_BARCODE::Serialize(), PCB_DIMENSION_BASE::Serialize(), PCB_GROUP::Serialize(), PCB_POINT::Serialize(), PCB_REFERENCE_IMAGE::Serialize(), PCB_SHAPE::Serialize(), PCB_TABLE::Serialize(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), ZONE::Serialize(), SetDimensionValueMode(), PCB_DIMENSION_BASE::SetEnd(), PAD::SetFPRelativeOrientation(), SetFPRelativePosition(), PAD::SetOffset(), PAD::SetOrientation(), PAD::SetPosition(), PCB_POINT::SetPosition(), PAD::SetPrimaryDrillSize(), PAD::SetSize(), PCB_DIMENSION_BASE::SetStart(), PCB_TEXT::SetTextAngle(), PCB_TEXT::SetTextSize(), PCB_TEXTBOX::SetTextSize(), PCB_TEXT::SetTextThickness(), PCB_TEXTBOX::SetTextThickness(), PCB_FIELDS_GRID_TABLE::SetValue(), PAD::SharesNetTieGroup(), BOARD_COMMIT::Stage(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), PCB_TEXTBOX::syncLibCoords(), PNS_KICAD_IFACE_BASE::syncZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testGraphicClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PCB_IO_EAGLE::transferPad(), PCB_SHAPE::transformFp(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), PCB_POINT_EDITOR::updateItem(), PAD::ViewGetLayers(), PCB_SHAPE::ViewGetLayers(), PCB_TEXT::ViewGetLayers(), PCB_TEXTBOX::ViewGetLayers(), PCB_FIELD::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and ZONE::ZONE().

◆ GetParentGroup()

virtual EDA_GROUP * EDA_ITEM::GetParentGroup ( ) const

inlinevirtualinherited

Reimplemented in PCB_TABLECELL, and SCH_TABLECELL.

Definition at line 116 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), MULTICHANNEL_TOOL::AutogenerateRuleAreas(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), EDIT_TOOL::DeleteItems(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), EDIT_TOOL::doMoveSelection(), BOARD_ITEM::Duplicate(), PCB_TABLE::Duplicate(), SCH_ITEM::Duplicate(), BOARD::ExchangeFootprint(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), TRACKS_CLEANER::filterItem(), MULTICHANNEL_TOOL::GeneratePotentialRuleAreas(), GENERATOR_TOOL::GENERATOR_TOOL(), getClosestGroup(), getClosestGroup(), PCB_TABLECELL::GetParentGroup(), SCH_TABLECELL::GetParentGroup(), GetParentGroupId(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), SCH_MOVE_TOOL::initializeMoveOperation(), isExpandableMicrovia(), isInTuningPattern(), BOARD_ITEM::IsLocked(), SCH_ITEM::IsLocked(), PCB_SELECTION_TOOL::isWithinEnteredGroup(), memberOfGroupFunc(), BOARD_EDITOR_CONTROL::modifyLockSelected(), BOARD::Move(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), BOARD::Remove(), PNS_KICAD_IFACE::RemoveItem(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), COMMIT::Stage(), BOARD_ITEM::SwapItemData(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), BOARD_NETLIST_UPDATER::updateGroups(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), PCB_GROUP::WithinScope(), and SCH_GROUP::WithinScope().

◆ GetParentGroupId()

KIID EDA_ITEM::GetParentGroupId ( ) const

inherited

Definition at line 232 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

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

◆ GetPosition()

VECTOR2I PCB_TABLE::GetPosition ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 308 of file pcb_table.cpp.

References m_cells.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), Flip(), GetEnd(), GetPositionX(), GetPositionY(), PCB_DRILL_CHART::RebuildCells(), SetPosition(), SetPositionX(), and SetPositionY().

◆ GetPositionX()

int PCB_TABLE::GetPositionX ( ) const

inlineinherited

Definition at line 117 of file pcb_table.h.

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

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ GetPositionY()

int PCB_TABLE::GetPositionY ( ) const

inlineinherited

Definition at line 118 of file pcb_table.h.

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

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ GetPrecision()

int PCB_DRILL_CHART::GetPrecision ( ) const

inline

Definition at line 79 of file pcb_drill_chart.h.

References m_precision.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_IO_KICAD_SEXPR::format(), and PCB_DRILL_CHART_DESC::PCB_DRILL_CHART_DESC().

◆ GetRolloverPos()

VECTOR2I EDA_ITEM::GetRolloverPos ( ) const

inlineinherited

Definition at line 143 of file eda_item.h.

References m_rolloverPos.

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

◆ GetRowCount()

int PCB_TABLE::GetRowCount ( ) const

inlineinherited

Definition at line 123 of file pcb_table.h.

References m_cells, and m_colCount.

Referenced by Autosize(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compare(), DrawBorders(), PCB_EDIT_TABLE_TOOL::ExportTableToCSV(), Flip(), PCB_IO_KICAD_SEXPR::formatTableData(), GetEffectiveShape(), GetEnd(), PCB_DRILL_CHART::GetItemDescription(), PCB_DRILL_CHART::GetMsgPanelInfo(), PCB_DRILL_CHART::IsDataRow(), Normalize(), and Serialize().

◆ GetRowHeight()

int PCB_TABLE::GetRowHeight ( int aRow ) const

inlineinherited

Definition at line 142 of file pcb_table.h.

References m_rowHeights.

Referenced by Compare(), PCB_IO_KICAD_SEXPR::formatTableData(), GetEnd(), and Serialize().

◆ GetSeparatorsColor()

COLOR4D PCB_TABLE::GetSeparatorsColor ( ) const

inlineinherited

Definition at line 99 of file pcb_table.h.

References m_separatorsStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ GetSeparatorsStroke()

const STROKE_PARAMS & PCB_TABLE::GetSeparatorsStroke ( ) const

inlineinherited

Definition at line 84 of file pcb_table.h.

References m_separatorsStroke.

Referenced by DrawBorders(), PCB_IO_KICAD_SEXPR::formatTableData(), and TransformShapeToPolygon().

◆ GetSeparatorsStyle()

LINE_STYLE PCB_TABLE::GetSeparatorsStyle ( ) const

inlineinherited

Definition at line 90 of file pcb_table.h.

References DEFAULT, m_separatorsStroke, and SOLID.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ GetSeparatorsWidth()

int PCB_TABLE::GetSeparatorsWidth ( ) const

inlineinherited

Definition at line 87 of file pcb_table.h.

References m_separatorsStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ GetShowTotals()

bool PCB_DRILL_CHART::GetShowTotals ( ) const

inline

Definition at line 87 of file pcb_drill_chart.h.

References m_showTotals.

Referenced by PCB_IO_KICAD_SEXPR::format(), and PCB_DRILL_CHART_DESC::PCB_DRILL_CHART_DESC().

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

References GetPosition().

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 155 of file board_item.cpp.

References DEFAULT_LINE_WIDTH, KIGFX::VIEW_ITEM::GetClass(), and pcbIUScale.

Referenced by CONVERT_TOOL::CreatePolys().

◆ GetSymbolColumn()

int PCB_DRILL_CHART::GetSymbolColumn ( ) const

inline

Table column the symbol is drawn in, or -1 when the chart has no symbol column.

Definition at line 141 of file pcb_drill_chart.h.

References m_symbolColumn.

Referenced by KIGFX::PCB_PAINTER::drawChartSymbols(), PCB_IO_KICAD_SEXPR::format(), and BRDITEMS_PLOTTER::PlotChartSymbols().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 183 of file eda_item.h.

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

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

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

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

Definition at line 556 of file eda_item.cpp.

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

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

◆ GetUnits()

DRILL_CHART_UNITS PCB_DRILL_CHART::GetUnits ( ) const

inline

Definition at line 76 of file pcb_drill_chart.h.

References m_units.

Referenced by PCB_IO_KICAD_SEXPR::format(), and PCB_DRILL_CHART_DESC::PCB_DRILL_CHART_DESC().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 133 of file board_item.h.

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

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 139 of file board_item.h.

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

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

◆ HasCustomProperties()

bool EDA_ITEM::HasCustomProperties ( ) const

inlineinherited

Definition at line 269 of file eda_item.h.

References m_customProperties.

Referenced by KICAD_FORMAT::FormatCustomProperties().

◆ HasDrilledHole()

virtual bool BOARD_ITEM::HasDrilledHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 212 of file board_item.h.

Referenced by PNS_PCBNEW_RULE_RESOLVER::IsDrilledHole(), and BOARD_INSPECTION_TOOL::reportClearance().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 168 of file eda_item.h.

References m_flags.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), BOOST_AUTO_TEST_CASE(), BOARD::BulkRemoveStaleTeardrops(), GRAPHICS_CLEANER::cleanupShapes(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), SYMBOL_EDIT_FRAME::ClearUndoORRedoList(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_MOVE_TOOL::findTargetSheet(), PCB_TUNING_PATTERN::Flip(), SYMBOL_EDIT_FRAME::freeTransientUndoCommands(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_SCREEN::MarkConnections(), PCB_TUNING_PATTERN::Mirror(), PCB_TUNING_PATTERN::Move(), MoveSchematicItem(), SCH_MOVE_TOOL::orthoLineDrag(), SCH_MOVE_TOOL::performItemMove(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), GERBVIEW_FRAME::RemapLayers(), PCB_TUNING_PATTERN::Rotate(), SCH_EDIT_TOOL::Rotate(), ISSUE22864_FIXTURE::RunAlignmentAndVerify(), ISSUE22864_FIXTURE::RunAlignmentAndVerifyNoSkew(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), PCB_SELECTION_TOOL::selectAllConnectedShapes(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), SCH_SELECTION_TOOL::SelectMultiple(), SCH_COMMIT::Stage(), TRACKS_CLEANER::testTrackEndpointIsNode(), SCH_MOVE_TOOL::trimDanglingLines(), SCH_FIND_REPLACE_TOOL::UpdateFind(), and PCB_TUNING_PATTERN::ViewDraw().

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 207 of file board_item.h.

Referenced by DRC_ENGINE::EvalRules(), DRC_RTREE::Insert(), ItemHasDRCViolation(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_DISALLOW::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), PCB_CONTROL::UpdateMessagePanel(), and PCB_TRACK::ViewBBox().

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

Referenced by CONVERT_TOOL::CreatePolys().

◆ HasSelectedAncestorGroup()

bool EDA_ITEM::HasSelectedAncestorGroup ( ) const

inherited

Returns: true if any ancestor group (recursively) of this item is currently selected. Group members do not carry the SELECTED flag themselves, so callers that need to know whether an item is moving as part of a group selection should use this helper.

Definition at line 241 of file eda_item.cpp.

References EDA_ITEM(), and group.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_MOVE_TOOL::getConnectedDragItems().

◆ HitTest() [1/3]

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

overridevirtualinherited

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

Definition at line 894 of file pcb_table.cpp.

References BOX2< Vec >::Contains(), GetBoundingBox(), BOX2< Vec >::Inflate(), and BOX2< Vec >::Intersects().

◆ HitTest() [2/3]

bool PCB_TABLE::HitTest	(	const SHAPE_LINE_CHAIN &	aPoly,
		bool	aContained ) const

overridevirtualinherited

Test if aPoly intersects this item.

Parameters

aPoly	A reference to a SHAPE_LINE_CHAIN object containing the polygon or polyline to test.
aContained	Set to true to test for containment instead of an intersection.

Returns: True if aPoly contains or intersects the item.

Reimplemented from EDA_ITEM.

Definition at line 907 of file pcb_table.cpp.

References GetEffectiveShape(), and KIGEOM::ShapeHitTest().

◆ HitTest() [3/3]

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

overridevirtualinherited

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

Definition at line 884 of file pcb_table.cpp.

References BOX2< Vec >::Contains(), GetBoundingBox(), and BOX2< Vec >::Inflate().

◆ InsertCell()

void PCB_TABLE::InsertCell	(	int	aIdx,
		PCB_TABLECELL *	aCell )

inlineinherited

Definition at line 172 of file pcb_table.h.

References BOARD_ITEM::GetLayer(), m_cells, PCB_SHAPE::SetLayer(), and EDA_ITEM::SetParent().

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 98 of file view_item.h.

References m_isBOARD_ITEM.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_GROUP_TOOL::canGroupItem(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), EDA_ITEM::EDA_ITEM(), PCB_BASE_FRAME::FocusOnItem(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), KIGFX::PCB_PAINTER::HasUniformColor(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD::Move(), PCB_GRID_HELPER::nearestAnchor(), PCB_GRID_HELPER::OnBoardItemRemoved(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), PCB_GRID_HELPER::ResolveSnap(), GRAPHIC_EDIT_TOOL::runInteractive(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::SelectAll(), PCB_EDIT_FRAME::SetPageSettings(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), BOARD_COMMIT::Stage(), EDIT_TOOL::Swap(), BOARD_COMMIT::undoLevelItem(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), PCB_SELECTION_TOOL::UnselectAll(), KIGFX::PCB_VIEW::Update(), KIGFX::PCB_VIEW::UpdateCollidingItems(), EDIT_TOOL::updateModificationPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

References BRIGHTENED, m_flags, and m_netHighlighted.

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

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

Definition at line 172 of file board_item.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PNS::NODE::FindItemByParent(), BOARD_INSPECTION_TOOL::getItemDescription(), hasExactNetclassFunc(), hasNetChainFunc(), hasNetclassFunc(), inDiffPairFunc(), inNetChainClassFunc(), inNetChainFunc(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), ZONE_PAINTER::PCB_PAINTER(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testGraphicClearances(), 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::testSingleLayerItemAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances().

◆ IsDataRow()

bool PCB_DRILL_CHART::IsDataRow ( int aRow ) const

True for a row that reports a drill group, false for the title, heading and totals.

Definition at line 230 of file pcb_drill_chart.cpp.

References PCB_TABLE::GetRowCount(), m_rowKeys, and m_showTotals.

Referenced by BOOST_AUTO_TEST_CASE(), and PCB_SELECTION_TOOL::selectChartRow().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 135 of file eda_item.h.

References ENTERED, and m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 233 of file eda_item.h.

References m_forceVisible.

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

◆ IsGroupableType()

bool BOARD_ITEM::IsGroupableType ( ) const

inherited

◆ IsIndexedInBoard()

bool BOARD_ITEM::IsIndexedInBoard ( ) const

inlineinherited

Definition at line 419 of file board_item.h.

References m_boardCacheOwner.

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Reimplemented in PCB_BARCODE.

Definition at line 413 of file board_item.h.

References m_isKnockout.

Referenced by FEATURES_MANAGER::AddText(), BOARD_ADAPTER::addText(), BOOST_AUTO_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_TEXT::GetBoundingBox(), PCB_TEXT::GetEffectiveShape(), PCB_FIELDS_GRID_TABLE::GetValueAsBool(), PCB_BARCODE::IsKnockout(), PCB_TEXT_DESC::PCB_TEXT_DESC(), PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC(), BRDITEMS_PLOTTER::PlotBoardGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), processTextItem(), PCB_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TEXT::TextHitTest(), PCB_TEXT::TextHitTest(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ IsLayerAgnostic()

virtual bool BOARD_ITEM::IsLayerAgnostic ( ) const

inlinevirtualinherited

Check if this item's layer set must not be confined to a board's enabled layers.

A container's layer set is its members', and those are confined individually; a footprint's children come from a library that knows no board's layers and must survive those layers being re-enabled; a geometric constraint has no layer at all. Masking any of them would corrupt the item. Whether the board accepts it at all is FitsEnabledLayers.

Reimplemented in FOOTPRINT, PCB_CONSTRAINT, and PCB_GROUP.

Definition at line 307 of file board_item.h.

Referenced by FitsEnabledLayers().

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 140 of file board_item.cpp.

References FPHOLDER, GetBoard(), EDA_ITEM::GetParentGroup(), group, and m_isLocked.

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 130 of file eda_item.h.

References IS_CHANGED, and m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ IsNetHighlighted()

bool EDA_ITEM::IsNetHighlighted ( ) const

inherited

Net highlighting must not clear brightening owned by find or picker tools.

Definition at line 125 of file eda_item.cpp.

References m_netHighlighted.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References IS_NEW, and m_flags.

Referenced by SCH_MOVE_TOOL::checkMoveInProgress(), SCH_EDIT_TOOL::CycleBodyStyle(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PCB_TUNING_PATTERN::EditStart(), PCB_VIA_STACK::EditStart(), PCB_VIA_STITCH::EditStart(), SCH_MOVE_TOOL::finalizeMoveOperation(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_MOVE_TOOL::initializeMoveOperation(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_SCREEN::IsTerminalPoint(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), SCH_POINT_EDITOR::Main(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_SELECTION_TOOL::select(), COMMIT::Unstage(), PCB_TUNING_PATTERN::Update(), and PCB_TUNING_PATTERN::ViewDraw().

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

Returns: true if the object is on any copper layer, false otherwise.

Reimplemented in PAD, PCB_GROUP, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 189 of file board_item.h.

References GetLayer(), GetLayerSet(), IsCopperLayer(), IsSingleLayerType(), and EDA_ITEM::Type().

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::CheckNetTies(), DRC_ENGINE::EvalRules(), PCB_SHAPE::GetItemDescription(), PCB_SHAPE::GetMsgPanelInfo(), PCB_SHAPE::IsConnected(), isCopper(), PCB_SELECTION_TOOL::isExpandableGraphicShape(), ZONE_PAINTER::PCB_PAINTER(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), PCB_SHAPE::SetLayer(), BOARD_CONNECTED_ITEM::SetNetCode(), shapeNeedsUpdate(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::UpdateMessagePanel(), and PCB_SHAPE::ViewGetLayers().

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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 in FOOTPRINT, PAD, PCB_BOARD_OUTLINE, PCB_GROUP, PCB_SHAPE, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 408 of file board_item.h.

References m_layer.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), CREEPAGE_GRAPH::AddNetElements(), ZONE_FILLER::buildCopperItemClearances(), FOOTPRINT::CheckClippedSilk(), CN_VISITOR::checkZoneItemConnection(), ComputeBoardStatistics(), existsOnLayerFunc(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), isEdge(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_COMMIT::Push(), DRC_TEST_PROVIDER_SOLDER_MASK::recordMaskAperture(), BOARD::RemoveAllItemsOnLayer(), BOARD_INSPECTION_TOOL::reportClearance(), ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), DRC_TEST_PROVIDER_SOLDER_MASK::testSilkToMaskClearance(), and PCB_CONTROL::UpdateMessagePanel().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 520 of file eda_item.h.

Referenced by Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References m_isRollover.

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

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 97 of file view_item.h.

References m_isSCH_ITEM.

Referenced by SCH_GROUP_TOOL::canGroupItem(), KIGFX::SCH_VIEW::DisplaySheet(), EDA_ITEM::EDA_ITEM(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), SCH_PROPERTIES_PANEL::getPropertyFromEvent(), EE_GRID_HELPER::ResolveSnap(), SCH_TOOL_BASE< T >::saveCopyInUndoList(), and KIGFX::SCH_VIEW::Update().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 134 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsSideSpecific()

bool BOARD_ITEM::IsSideSpecific ( ) const

inherited

Definition at line 235 of file board_item.cpp.

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

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

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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

Parameters

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

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

Reimplemented in PCB_VIA.

Definition at line 224 of file board_item.h.

Referenced by BOARD_INSPECTION_TOOL::reportClearance(), and DRC_TEST_PROVIDER_SILK_CLEARANCE::Run().

◆ IsType()

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

inlinevirtualinherited

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 in PAD, PCB_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_VIA, SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, and SCH_LINE.

Definition at line 214 of file eda_item.h.

References m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), EDIT_TOOL::BooleanPolygons(), PNS_KICAD_IFACE::createBoardItem(), groupMirrorable(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EDIT_TOOL::HealShapes(), PAD::IsType(), PCB_FIELD::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), SCH_ITEM::IsType(), PL_POINT_EDITOR::Main(), SCH_POINT_EDITOR::Main(), CONVERT_TOOL::makePolysFromChainedSegs(), EDIT_TOOL::ModifyLines(), CONVERT_TOOL::OutsetItems(), SCH_SELECTION_TOOL::RequestSelection(), CONVERT_TOOL::SegmentToArc(), EDIT_TOOL::SimplifyPolygons(), SCH_EDITOR_CONTROL::SimProbe(), SCH_COMMIT::undoLevelItem(), KIGFX::PCB_VIEW::UpdateCollidingItems(), and Visit().

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

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

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

◆ IterateForward() [2/2]

template<class T>

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

inlinestaticinherited

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

Definition at line 421 of file eda_item.h.

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

◆ LayerMaskDescribe()

wxString BOARD_ITEM::LayerMaskDescribe ( ) const

virtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 252 of file board_item.cpp.

References _, LSET::AllCuMask(), LSET::AllTechMask(), BOARD, GetBoard(), BOARD::GetCopperLayerCount(), BOARD::GetEnabledLayers(), BOARD::GetLayerName(), GetLayerSet(), LayerName(), MAX_CU_LAYERS, PCB_LAYER_ID_COUNT, PCBNEW_LAYER_ID_START, and ToLAYER_ID().

Referenced by PAD::GetItemDescription(), PAD::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), and PCB_TUNING_PATTERN::GetMsgPanelInfo().

◆ lodScaleForThreshold()

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

staticprotectedinherited

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

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

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

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

Definition at line 35 of file view_item.cpp.

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

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

◆ Matches() [1/2]

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

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

◆ Matches() [2/2]

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

inlineoverridevirtualinherited

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

Definition at line 276 of file pcb_table.h.

◆ migrateRows()

void PCB_DRILL_CHART::migrateRows	(	int	aRows,
		int	aCols,
		int	aFirstDataRow,
		const std::vector< std::string > &	aNewRowKeys )

private

Move each row's cells to the row that reports the same drill group.

Formatting lives on the cells, so without this a rebuild that adds or removes a group would hand a row's formatting to whichever group happened to land on its index. Rows whose group has gone are deleted and rows for a new group are created, leaving the table exactly aRows by aCols.

Definition at line 115 of file pcb_drill_chart.cpp.

References empty(), PCB_TABLE::GetColCount(), BOARD_ITEM::GetLayer(), PCB_TABLE::m_cells, PCB_TABLE::m_rowHeights, and m_rowKeys.

Referenced by RebuildCells().

◆ Mirror()

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

overridevirtualinherited

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 606 of file pcb_table.cpp.

References ANGLE_180, Flip(), BOARD_ITEM::GetLayer(), LEFT_RIGHT, m_cells, Rotate(), SetLayer(), and TOP_BOTTOM.

◆ Move()

void PCB_TABLE::Move ( const VECTOR2I & aMoveVector )

overridevirtualinherited

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 483 of file pcb_table.cpp.

References m_cells.

Referenced by BOOST_AUTO_TEST_CASE(), Flip(), PCB_CONTROL::PlaceDrillChart(), PCB_DRILL_CHART::RebuildCells(), and SetPosition().

◆ Normalize()

void PCB_TABLE::Normalize ( )

overridevirtualinherited

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

Reimplemented from BOARD_ITEM.

Definition at line 331 of file pcb_table.cpp.

References ANGLE_0, EDA_TEXT::ClearRenderCache(), correction, end, GetCell(), BOX2< Vec >::GetCenter(), GetColCount(), PCB_TABLECELL::GetColSpan(), EDA_SHAPE::GetEnd(), PCB_SHAPE::GetPosition(), GetRowCount(), PCB_TABLECELL::GetRowSpan(), m_cells, m_colWidths, m_rowHeights, RotatePoint(), PCB_SHAPE::SetEnd(), PCB_SHAPE::SetPosition(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Autosize(), checkNormalizeIsStable(), Flip(), PCB_DRILL_CHART::RebuildCells(), and Rotate().

◆ NormalizeForCompare()

virtual void BOARD_ITEM::NormalizeForCompare ( )

inlinevirtualinherited

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

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

Reimplemented in PCB_SHAPE.

Definition at line 494 of file board_item.h.

References Normalize().

◆ OnFootprintRescaled()

void PCB_TABLE::OnFootprintRescaled	(	double	aRatioX,
		double	aRatioY,
		double	aLinearFactor,
		const VECTOR2I &	aAnchor,
		const EDA_ANGLE &	aParentRotate )

overridevirtualinherited

Apply a parent footprint scale to this item.

Default is a no-op. Items with sizable geometry (PAD, PCB_SHAPE, PCB_TEXT, ZONE) override.

Parameters

aRatioX	new Sx / old Sx (multiply X-axis-aligned values by this).
aRatioY	same for Y.
aLinearFactor	weighted factor for stroke / thickness.
aAnchor	scale anchor (the parent footprint's translate).
aParentRotate	current parent rotation. Needed by POLY / BEZIER to unrotate before scaling and rotate back.

Reimplemented from BOARD_ITEM.

Definition at line 509 of file pcb_table.cpp.

References m_cells.

◆ OnFootprintTransformed()

void PCB_TABLE::OnFootprintTransformed ( )

overridevirtualinherited

Hook for items inside a footprint to refresh after the FP transform changes (translate, rotate, flip).

Scaling uses OnFootprintRescaled.

Reimplemented from BOARD_ITEM.

Definition at line 502 of file pcb_table.cpp.

References m_cells.

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

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

◆ operator=()

PCB_DRILL_CHART & PCB_DRILL_CHART::operator= ( const PCB_DRILL_CHART & )

delete

References PCB_DRILL_CHART().

◆ operator==() [1/2]

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

overridevirtual

Implements BOARD_ITEM.

Definition at line 299 of file pcb_drill_chart.cpp.

References BOARD_ITEM::BOARD_ITEM(), m_columns, m_filter, m_precision, m_rowKeys, m_rowShapes, m_showTotals, m_symbolColumn, m_units, PCB_TABLE::operator==(), PCB_DRILL_CHART(), and EDA_ITEM::Type().

◆ operator==() [2/2]

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

inherited

Definition at line 972 of file pcb_table.cpp.

References m_borderStroke, m_cells, m_colWidths, m_rowHeights, m_separatorsStroke, m_strokeColumns, m_strokeExternal, m_StrokeHeaderSeparator, m_strokeRows, and PCB_TABLE().

Referenced by PCB_DRILL_CHART::operator==().

◆ RebuildCells()

void PCB_DRILL_CHART::RebuildCells	(	const BOARD &	aBoard,
		DRILL_SYMBOL_PROFILE *	aAssignedProfile = nullptr )

Regenerate the cells from the board.

Cells are reused rather than recreated so their UUIDs survive, which keeps selection restore and file diffs meaningful. Symbol assignments are worked out on a copy of the board's profile. AAssignedProfile receives it so the caller can commit it as an undoable board change once placement has actually happened. Passing nullptr discards new assignments, which is what a preview wants.

Definition at line 402 of file pcb_drill_chart.cpp.

References anchor, ASPECT_RATIO, AssignDrillSymbols(), PCB_TABLE::Autosize(), BACKDRILL_STUB, BOARD_ITEM::BOARD, buildGroups(), CENTER, DESCRIPTION, DRILL_DIAMETER, empty(), PCB_TABLE::GetCell(), PCB_TABLE::GetCells(), PCB_TABLE::GetColWidth(), BOARD::GetDrillModelGeneration(), BOARD_STACKUP::GetLayerDistance(), PCB_TABLE::GetPosition(), BOARD::GetStackupOrDefault(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, group, LAYER_SPAN, LEFT, m_builtGeneration, m_columns, m_precision, m_rowKeys, m_rowShapes, m_showTotals, m_symbolColumn, m_units, migrateRows(), PCB_TABLE::Move(), NO_VALUE, PCB_TABLE::Normalize(), OPERATION, OPERATION_COUNT, PLATING, PROTECTION, PCB_TABLE::ResizeCells(), ResolveDrillSymbols(), RIGHT, PCB_TABLE::SetColCount(), PCB_TABLE::SetColWidth(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetText(), SHAPE, SITE_COUNT, SLOT_SIZE, SYMBOL, text, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_CONTROL::PlaceDrillChart(), RefreshDrillCharts(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ RemapKIIDs()

virtual void BOARD_ITEM::RemapKIIDs ( const std::map< KIID, KIID > & aIdMap )

inlinevirtualinherited

Remap KIIDs this item stores to reference other items (e.g.

constraint members) through aIdMap (old -> new), after a paste/duplicate has re-UUIDed the referenced items. KIIDs absent from the map are left unchanged. The default does nothing.

Reimplemented in PCB_CONSTRAINT.

Definition at line 287 of file board_item.h.

Referenced by PCB_CONTROL::placeBoardItems().

◆ Remove()

void PCB_TABLE::Remove	(	BOARD_ITEM *	aItem,
		REMOVE_MODE	aMode = REMOVE_MODE::NORMAL )

inlineoverridevirtualinherited

Removes an item from the container.

Implements BOARD_ITEM_CONTAINER.

Definition at line 215 of file pcb_table.h.

References BOARD_ITEM::BOARD_ITEM(), and NORMAL.

◆ RemoveConflictingCustomProperties()

std::vector< wxString > EDA_ITEM::RemoveConflictingCustomProperties ( )

inherited

Remove custom properties whose keys collide with an existing field or built-in property name (matched case-insensitively).

Returns the keys removed, if any.

Definition at line 168 of file eda_item.cpp.

References _HKI, PROPERTY_MANAGER::Instance(), m_customProperties, and RemoveCustomProperty().

◆ RemoveCustomProperty()

void EDA_ITEM::RemoveCustomProperty ( const wxString & aKey )

inherited

Definition at line 161 of file eda_item.cpp.

References m_customProperties, and m_dynamicCustomPropsCache.

Referenced by PCB_PROPERTIES_PANEL::onKeyRenamed(), SCH_PROPERTIES_PANEL::onKeyRenamed(), RemoveConflictingCustomProperties(), and SCH_PROPERTIES_PANEL::removeCustomProperty().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 196 of file eda_item.h.

◆ Replace() [1/2]

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

inlinevirtualinherited

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

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

Parameters

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

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

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

Definition at line 509 of file eda_item.h.

◆ Replace() [2/2]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 396 of file eda_item.cpp.

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

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

◆ ResetUuid()

void BOARD_ITEM::ResetUuid ( )

inlineinherited

Definition at line 280 of file board_item.h.

References SetUuid().

Referenced by CloneFullySelectedConstraints(), MULTICHANNEL_TOOL::copyRuleAreaContents(), Duplicate(), PCB_TABLE::Duplicate(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), API_HANDLER_PCB::handlePlaceFootprintFromLibrary(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ ResetUuidDirect()

void BOARD_ITEM::ResetUuidDirect ( )

inlineinherited

Definition at line 277 of file board_item.h.

References SetUuidDirect().

Referenced by PCB_EDIT_TABLE_TOOL::copyCell(), MULTICHANNEL_TOOL::copyRuleAreaContents(), MICROWAVE_TOOL::createMicrowaveInductor(), DRAWING_TOOL::DrawVia(), FOOTPRINT::Duplicate(), FOOTPRINT::DuplicateItem(), and LoadNetlistFootprints().

◆ ResizeCells()

void PCB_TABLE::ResizeCells	(	int	aRows,
		int	aCols )

inherited

Grow or shrink to aRows x aCols, keeping the cells that already exist.

A regenerating table must not clear and repopulate. That would mint new UUIDs on every rebuild and break selection restore and file diffs.

Definition at line 276 of file pcb_table.cpp.

References AddCell(), m_cells, and m_colCount.

Referenced by PCB_DRILL_CHART::RebuildCells().

◆ Rotate()

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

overridevirtualinherited

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from BOARD_ITEM.

Definition at line 490 of file pcb_table.cpp.

References empty(), GetCells(), m_cells, and Normalize().

Referenced by Flip(), and Mirror().

◆ RowKeys() [1/2]

std::map< int, std::string > & PCB_DRILL_CHART::RowKeys ( )

inline

Definition at line 131 of file pcb_drill_chart.h.

References m_rowKeys.

◆ RowKeys() [2/2]

const std::map< int, std::string > & PCB_DRILL_CHART::RowKeys ( ) const

inline

Drill group each generated row reports on, by table row.

A rebuild reorders rows as holes come and go, so this is what lets a row's formatting follow its group rather than its position. Serialized, because the first rebuild after a load would otherwise have nothing to match the loaded rows against.

Definition at line 130 of file pcb_drill_chart.h.

References m_rowKeys.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PCB_IO_KICAD_SEXPR::format().

◆ RowShapes() [1/2]

std::map< int, int > & PCB_DRILL_CHART::RowShapes ( )

inline

Definition at line 121 of file pcb_drill_chart.h.

References m_rowShapes.

◆ RowShapes() [2/2]

const std::map< int, int > & PCB_DRILL_CHART::RowShapes ( ) const

inline

Curated shape index for each generated row, by table row.

A shape mark has no text, so without this the symbol column of every default chart is blank. Part of the generated snapshot, so it is serialized with the cells rather than recomputed, which would let a stale chart silently re-symbolize itself.

Definition at line 120 of file pcb_drill_chart.h.

References m_rowShapes.

Referenced by KIGFX::PCB_PAINTER::drawChartSymbols(), PCB_IO_KICAD_SEXPR::format(), and BRDITEMS_PLOTTER::PlotChartSymbols().

◆ RunOnChildren()

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

overridevirtualinherited

Invoke a function on all children.

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

Reimplemented from BOARD_ITEM.

Definition at line 638 of file pcb_table.cpp.

References BOARD_ITEM::BOARD_ITEM(), m_cells, and RECURSE.

◆ Serialize()

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

overridevirtual

Serializes this object to the given Any message.

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

Parameters

aContainer will be filled with a message describing this object

Reimplemented from SERIALIZABLE.

Definition at line 634 of file pcb_drill_chart.cpp.

References filter, INCH, m_columns, m_filter, m_precision, m_rowKeys, m_rowShapes, m_showTotals, m_symbolColumn, m_units, MM, kiapi::common::PackDistance(), and PCB_TABLE::Serialize().

Referenced by BOOST_FIXTURE_TEST_CASE().

◆ Set() [1/4]

template<typename T>

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

inherited

Definition at line 48 of file inspectable_impl.h.

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

◆ Set() [2/4]

template<typename T>

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

inherited

Definition at line 31 of file inspectable_impl.h.

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

◆ Set() [3/4]

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

inherited

Definition at line 28 of file inspectable.cpp.

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

Referenced by KICAD_DIFF::ApplyPropertyResolutions(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), MATCH_PROPERTIES_CATALOG::Copy(), PCB_PROPERTIES_PANEL::valueChanged(), and SCH_PROPERTIES_PANEL::valueChanged().

◆ Set() [4/4]

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

inherited

Definition at line 45 of file inspectable.cpp.

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

◆ SetBorderColor()

void PCB_TABLE::SetBorderColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 80 of file pcb_table.h.

References m_borderStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetBorderStroke()

void PCB_TABLE::SetBorderStroke ( const STROKE_PARAMS & aParams )

inlineinherited

Definition at line 65 of file pcb_table.h.

References m_borderStroke.

◆ SetBorderStyle()

void PCB_TABLE::SetBorderStyle ( const LINE_STYLE aStyle )

inlineinherited

Definition at line 71 of file pcb_table.h.

References m_borderStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetBorderWidth()

void PCB_TABLE::SetBorderWidth ( int aWidth )

inlineinherited

Definition at line 68 of file pcb_table.h.

References m_borderStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 151 of file eda_item.h.

References BRIGHTENED, and SetFlags().

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

◆ SetColCount()

void PCB_TABLE::SetColCount ( int aCount )

inlineinherited

Definition at line 120 of file pcb_table.h.

References m_colCount.

Referenced by Deserialize(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), and PCB_DRILL_CHART::RebuildCells().

◆ SetColWidth()

void PCB_TABLE::SetColWidth	(	int	aCol,
		int	aWidth )

inlineinherited

Definition at line 130 of file pcb_table.h.

References m_colWidths.

Referenced by Autosize(), Deserialize(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), and PCB_DRILL_CHART::RebuildCells().

◆ SetCustomProperties()

void EDA_ITEM::SetCustomProperties ( const std::map< wxString, wxString > & aProps )

inlineinherited

Definition at line 247 of file eda_item.h.

References m_customProperties, and SetCustomProperty().

Referenced by kiapi::common::UnpackCustomProperties().

◆ SetCustomProperty()

void EDA_ITEM::SetCustomProperty	(	const wxString &	aKey,
		const wxString &	aValue )

inlineinherited

Definition at line 255 of file eda_item.h.

References m_customProperties.

Referenced by SCH_PROPERTIES_PANEL::addBlankCustomProperty(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_PROPERTIES_PANEL::onKeyRenamed(), SCH_PROPERTIES_PANEL::onKeyRenamed(), PCB_IO_KICAD_SEXPR_PARSER::parseCustomProperty(), SCH_IO_KICAD_SEXPR_PARSER::parseCustomProperty(), SetCustomProperties(), and EDA_CUSTOM_PROPERTY::setter().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 158 of file eda_item.h.

References m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 162 of file view_item.h.

References m_forcedTransparency.

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

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

References m_forceVisible.

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

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 424 of file board_item.cpp.

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

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

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

◆ SetIsRollover()

void EDA_ITEM::SetIsRollover	(	bool	aIsRollover,
		const VECTOR2I &	aMousePos )

inlineinherited

Definition at line 144 of file eda_item.h.

References m_isRollover, and m_rolloverPos.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 198 of file eda_item.h.

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

◆ SetLayer()

void PCB_TABLE::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtualinherited

Set the layer this item is on.

Parameters

aLayer The layer number.

Reimplemented from BOARD_ITEM.

Definition at line 293 of file pcb_table.cpp.

References m_cells, and BOARD_ITEM::m_layer.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Deserialize(), Flip(), Mirror(), and PCB_CONTROL::PlaceDrillChart().

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( const LSET & aLayers )

inlinevirtualinherited

Reimplemented in BOARD, PAD, PCB_GRID_ITEM, PCB_SHAPE, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 354 of file board_item.h.

References KIGFX::VIEW_ITEM::GetClass(), LSET::Seq(), SetLayer(), and UNIMPLEMENTED_FOR.

Referenced by MULTICHANNEL_TOOL::copyRuleAreaContents(), BOARD::RemoveAllItemsOnLayer(), and GLOBAL_EDIT_TOOL::swapBoardItem().

◆ SetLocked()

void BOARD_ITEM::SetLocked ( bool aLocked )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in FOOTPRINT, and PCB_GROUP.

Definition at line 417 of file board_item.h.

References m_isLocked.

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 260 of file eda_item.cpp.

References IS_CHANGED, m_parent, and SetFlags().

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), SCH_IO_ALTIUM::ParseASCIISchematic(), and SCH_IO_ALTIUM::ParseFileHeader().

◆ SetNetHighlighted()

void EDA_ITEM::SetNetHighlighted ( bool aHighlighted )

inherited

Definition at line 131 of file eda_item.cpp.

References m_netHighlighted.

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

◆ SetParent()

void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

virtualinherited

Reimplemented in LIB_SYMBOL, NETINFO_ITEM, and PCB_POINT.

Definition at line 153 of file eda_item.cpp.

References EDA_ITEM(), and m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), PCB_TABLE::AddCell(), SCH_TABLE::AddCell(), LIB_SYMBOL::AddDrawItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCHEMATIC::AddTopLevelSheet(), SCH_SCREEN::Append(), PADSTACK::AppendPrimitives(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), CONNECTION_GRAPH::boost_test_update_generic_connectivity, CONNECTION_GRAPH::boost_test_update_symbol_connectivity, CADSTAR_SCH_ARCHIVE_LOADER::copySymbolItems(), SPRINT_LAYOUT_PARSER::CreateBoard(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), LIB_SYMBOL_LIBRARY_MANAGER::CreateSymbol(), FIELDS_GRID_TABLE::DetachFields(), FOOTPRINT_EDITOR_CONTROL::editFootprintPropertiesFromLibrary(), SCHEMATIC::ensureVirtualRoot(), FOOTPRINT_LIBRARY_ADAPTER::enumerateLibrary(), BOARD::ExchangeFootprint(), PAD_TOOL::explodePad(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), LIB_SYMBOL::Flatten(), PCB_IO_KICAD_SEXPR::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), PCB_TABLE::InsertCell(), SCH_TABLE::InsertCell(), LIB_SYMBOL::LIB_SYMBOL(), LTSPICE_SCHEMATIC::Load(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases(), PCB_IO_GEDA::loadBoard(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), SCH_IO_KICAD_LEGACY::loadHierarchy(), SCH_IO_KICAD_SEXPR::loadHierarchy(), SCH_IO_DATABASE::loadSymbolFromRow(), SCH_IO_EAGLE::loadSymbolPolyLine(), SCH_IO_EAGLE::loadSymbolRectangle(), SCH_IO_EAGLE::loadSymbolWire(), PCB_POINT_EDITOR::OnSelectionChange(), LIB_SYMBOL::operator=(), SCH_IO_KICAD_SEXPR_PARSER::parseLibSymbol(), SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceMicroviaStack(), PlaceRemoteDownloadedSymbol(), PlotFootprintToSVG(), FOOTPRINT_EDIT_FRAME::prepareFootprintTabHandoff(), BACK_ANNOTATE::processNetNameChange(), KI_TEST::ReadSchematicFromStream(), PAD::Recombine(), FOOTPRINT_EDIT_FRAME::RefreshLibraryFootprintTab(), SCH_IO_LIB_CACHE::removeSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CLIPBOARD_IO::SaveSelection(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), PCB_POINT::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), FOOTPRINT::swapData(), PCB_BARCODE::swapData(), PCB_TABLE::swapData(), SCH_LABEL_BASE::swapData(), SCH_SHEET::swapData(), SCH_SYMBOL::swapData(), SCH_TABLE::swapData(), BOARD_ITEM::SwapItemData(), SCH_ITEM::SwapItemData(), SCH_SYMBOL::SyncOtherUnits(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), FOOTPRINT::UpdateFields(), and PCB_IO_SPRINT_LAYOUT::~PCB_IO_SPRINT_LAYOUT().

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

Definition at line 115 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), BOOST_AUTO_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), FOOTPRINT_LIBRARY_ADAPTER::enumerateLibrary(), FOOTPRINT_EDIT_FRAME::findOrCreateFootprintInstanceTab(), PCB_IO_KICAD_SEXPR::FootprintSave(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_SYMBOL::GetOrientation(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), EDA_GROUP::RemoveItem(), FOOTPRINT_LIBRARY_ADAPTER::SaveFootprint(), CLIPBOARD_IO::SaveSelection(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), PCB_GROUP::swapChildOwnership(), SCH_GROUP::swapData(), and BOARD_ITEM::SwapItemData().

◆ SetPosition()

void PCB_TABLE::SetPosition ( const VECTOR2I & aPos )

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 302 of file pcb_table.cpp.

References GetPosition(), and Move().

Referenced by SetPositionX(), and SetPositionY().

◆ SetPositionX()

void PCB_TABLE::SetPositionX ( int x )

inlineinherited

Definition at line 115 of file pcb_table.h.

References GetPosition(), and SetPosition().

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetPositionY()

void PCB_TABLE::SetPositionY ( int y )

inlineinherited

Definition at line 116 of file pcb_table.h.

References GetPosition(), and SetPosition().

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetPrecision()

void PCB_DRILL_CHART::SetPrecision ( int aPrecision )

inline

Clamped.

The value reaches a "%.*f" format, where a hostile file asking for two billion decimals would try to allocate gigabytes.

Definition at line 85 of file pcb_drill_chart.h.

References m_precision.

Referenced by BOOST_AUTO_TEST_CASE(), Deserialize(), and PCB_DRILL_CHART_DESC::PCB_DRILL_CHART_DESC().

◆ SetRowHeight()

void PCB_TABLE::SetRowHeight	(	int	aRow,
		int	aHeight )

inlineinherited

Definition at line 140 of file pcb_table.h.

References m_rowHeights.

Referenced by Autosize(), Deserialize(), and TEST_BOARD_ITEM_FIXTURE::Instantiate().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 150 of file eda_item.h.

References SELECTED, and SetFlags().

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

◆ SetSeparatorsColor()

void PCB_TABLE::SetSeparatorsColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 98 of file pcb_table.h.

References m_separatorsStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetSeparatorsStroke()

void PCB_TABLE::SetSeparatorsStroke ( const STROKE_PARAMS & aParams )

inlineinherited

Definition at line 83 of file pcb_table.h.

References m_separatorsStroke.

◆ SetSeparatorsStyle()

void PCB_TABLE::SetSeparatorsStyle ( const LINE_STYLE aStyle )

inlineinherited

Definition at line 89 of file pcb_table.h.

References m_separatorsStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetSeparatorsWidth()

void PCB_TABLE::SetSeparatorsWidth ( int aWidth )

inlineinherited

Definition at line 86 of file pcb_table.h.

References m_separatorsStroke.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetShowTotals()

void PCB_DRILL_CHART::SetShowTotals ( bool aShow )

inline

Definition at line 88 of file pcb_drill_chart.h.

References m_showTotals.

Referenced by PCB_DRILL_CHART_DESC::PCB_DRILL_CHART_DESC().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 163 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass().

◆ SetStrokeColumns()

void PCB_TABLE::SetStrokeColumns ( bool aDoStroke )

inlineinherited

Definition at line 101 of file pcb_table.h.

References m_strokeColumns.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetStrokeExternal()

void PCB_TABLE::SetStrokeExternal ( bool aDoStroke )

inlineinherited

Definition at line 59 of file pcb_table.h.

References m_strokeExternal.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetStrokeHeaderSeparator()

void PCB_TABLE::SetStrokeHeaderSeparator ( bool aDoStroke )

inlineinherited

Definition at line 62 of file pcb_table.h.

References m_StrokeHeaderSeparator.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetStrokeRows()

void PCB_TABLE::SetStrokeRows ( bool aDoStroke )

inlineinherited

Definition at line 104 of file pcb_table.h.

References m_strokeRows.

Referenced by PCB_TABLE_DESC::PCB_TABLE_DESC().

◆ SetSymbolColumn()

void PCB_DRILL_CHART::SetSymbolColumn ( int aCol )

inline

Definition at line 142 of file pcb_drill_chart.h.

References m_symbolColumn.

◆ SetUnits()

void PCB_DRILL_CHART::SetUnits ( DRILL_CHART_UNITS aUnits )

inline

Definition at line 77 of file pcb_drill_chart.h.

References m_units.

Referenced by BOOST_AUTO_TEST_CASE(), and PCB_DRILL_CHART_DESC::PCB_DRILL_CHART_DESC().

◆ SetUuid()

void BOARD_ITEM::SetUuid ( const KIID & aUuid )

inherited

Definition at line 118 of file board_item.cpp.

References BOARD, m_boardCacheOwner, EDA_ITEM::m_Uuid, and SetUuidDirect().

Referenced by BOOST_AUTO_TEST_CASE(), BOARD::ExchangeFootprint(), processTextItem(), ResetUuid(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), and BOARD_NETLIST_UPDATER::updateFootprintGroup().

◆ SetUuidDirect()

void BOARD_ITEM::SetUuidDirect ( const KIID & aUuid )

inherited

Raw UUID assignment.

No board index maintenance.

Use for detached/load-time items only. Prefer SetUuid() for normal callers.

Definition at line 134 of file board_item.cpp.

References EDA_ITEM::m_Uuid.

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 155 of file board_item.h.

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

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

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 161 of file board_item.h.

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

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

◆ Similarity()

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

overridevirtual

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

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

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

Implements BOARD_ITEM.

Definition at line 290 of file pcb_drill_chart.cpp.

References BOARD_ITEM::BOARD_ITEM(), PCB_TABLE::Similarity(), and EDA_ITEM::Type().

◆ Sort()

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

inlinestaticinherited

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

Parameters

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

Returns: True if aLeft is less than aRight.

Definition at line 538 of file eda_item.h.

References EDA_ITEM().

◆ StrokeColumns()

bool PCB_TABLE::StrokeColumns ( ) const

inlineinherited

Definition at line 102 of file pcb_table.h.

References m_strokeColumns.

Referenced by DrawBorders(), PCB_IO_KICAD_SEXPR::formatTableData(), PCB_TABLE_DESC::PCB_TABLE_DESC(), and TransformShapeToPolygon().

◆ StrokeExternal()

bool PCB_TABLE::StrokeExternal ( ) const

inlineinherited

Definition at line 60 of file pcb_table.h.

References m_strokeExternal.

Referenced by DrawBorders(), PCB_IO_KICAD_SEXPR::formatTableData(), PCB_TABLE_DESC::PCB_TABLE_DESC(), and TransformShapeToPolygon().

◆ StrokeHeaderSeparator()

bool PCB_TABLE::StrokeHeaderSeparator ( ) const

inlineinherited

Definition at line 63 of file pcb_table.h.

References m_StrokeHeaderSeparator.

Referenced by DrawBorders(), PCB_IO_KICAD_SEXPR::formatTableData(), PCB_TABLE_DESC::PCB_TABLE_DESC(), and TransformShapeToPolygon().

◆ StrokeRows()

bool PCB_TABLE::StrokeRows ( ) const

inlineinherited

Definition at line 105 of file pcb_table.h.

References m_strokeRows.

Referenced by DrawBorders(), PCB_IO_KICAD_SEXPR::formatTableData(), PCB_TABLE_DESC::PCB_TABLE_DESC(), and TransformShapeToPolygon().

◆ StyleFromSettings()

virtual void BOARD_ITEM::StyleFromSettings	(	const BOARD_DESIGN_SETTINGS &	settings,
		bool	aCheckSide )

inlinevirtualinherited

Reimplemented in PCB_BARCODE, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TEXT, and PCB_TEXTBOX.

Definition at line 423 of file board_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ swapData()

void PCB_DRILL_CHART::swapData ( BOARD_ITEM * aImage )

overrideprotectedvirtual

Reimplemented from PCB_TABLE.

Definition at line 80 of file pcb_drill_chart.cpp.

References BOARD_ITEM::BOARD_ITEM(), m_builtGeneration, m_columns, m_filter, m_precision, m_rowKeys, m_rowShapes, m_showTotals, m_symbolColumn, m_units, PCB_DRILL_CHART(), PCB_TABLE::swapData(), and EDA_ITEM::Type().

◆ SwapItemData()

void BOARD_ITEM::SwapItemData ( BOARD_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

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

Parameters

aImage the item image which contains data to swap.

Definition at line 320 of file board_item.cpp.

References BOARD, BOARD_ITEM(), BOARD::CacheChildrenById(), EDA_ITEM::EDA_ITEM(), GetBoard(), GetParent(), EDA_ITEM::GetParentGroup(), group, EDA_ITEM::SetParent(), EDA_ITEM::SetParentGroup(), swapData(), and BOARD::UncacheChildrenById().

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

◆ TransformGraphicItemsToPolySet()

void PCB_TABLE::TransformGraphicItemsToPolySet	(	SHAPE_POLY_SET &	aBuffer,
		int	aMaxError,
		ERROR_LOC	aErrorLoc,
		KIGFX::RENDER_SETTINGS *	aRenderSettings ) const

inherited

Convert graphic items (segments and texts) to a set of polygonal shapes.

Definition at line 789 of file pcb_table.cpp.

References DrawBorders(), ERROR_INSIDE, FIRST_TYPE, STROKE_PARAMS::GetLineStyle(), STROKE_PARAMS::GetWidth(), m_cells, STROKE_PARAMS::Stroke(), TransformCircleToPolygon(), and TransformOvalToPolygon().

Referenced by TransformShapeToPolySet().

◆ TransformShapeToPolygon()

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

overridevirtualinherited

Convert the item shape to a closed polygon.

Circles and arcs are approximated by segments.

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 773 of file pcb_table.cpp.

References GetBorderStroke(), GetSeparatorsStroke(), m_cells, StrokeColumns(), StrokeExternal(), StrokeHeaderSeparator(), and StrokeRows().

◆ TransformShapeToPolySet()

void PCB_TABLE::TransformShapeToPolySet	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc,
		KIGFX::RENDER_SETTINGS *	aRenderSettings = nullptr ) const

overridevirtualinherited

Convert the TABLE shape to a polyset.

details will be included.

Parameters

aBuffer	a buffer to store the polygon.
aClearance	the clearance around the pad.
aError	the maximum deviation from true circle.
aErrorLoc	should the approximation error be placed outside or inside the polygon?
aRenderSettings	used to plot outlines with not solid segments like dashed lines. If null, lines like dashed will be converted as SOLID

Reimplemented from BOARD_ITEM.

Definition at line 832 of file pcb_table.cpp.

References SHAPE_POLY_SET::Append(), CHAMFER_ALL_CORNERS, SHAPE_POLY_SET::Inflate(), and TransformGraphicItemsToPolySet().

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

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

Returns: the type of object.

Definition at line 110 of file eda_item.h.

References m_structType.

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

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

Returns: the current bounding box.

Implements KIGFX::VIEW_ITEM.

Reimplemented in CONSTRAINT_BADGE_ITEM, DS_PROXY_VIEW_ITEM, EDIT_POINTS, FOOTPRINT, GERBER_DRAW_ITEM, KIGFX::ANCHOR_DEBUG, KIGFX::CONSTRUCTION_GEOM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ANGLE_ITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::BEZIER_ASSISTANT, KIGFX::PREVIEW::CENTRELINE_RECT_ITEM, KIGFX::PREVIEW::ELLIPSE_ASSISTANT, KIGFX::PREVIEW::POLYGON_ITEM, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::SNAP_INDICATOR, MY_DRAWING, PAD, PCB_BARCODE, PCB_DIM_CENTER, PCB_DIMENSION_BASE, PCB_MARKER, PCB_SHAPE, PCB_TEXT, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA_STACK, RATSNEST_VIEW_ITEM, RECT_RADIUS_TEXT_ITEM, ROUTER_PREVIEW_ITEM, ROUTER_STATUS_VIEW_ITEM, SCH_PIN, and TUNING_STATUS_VIEW_ITEM.

Definition at line 509 of file eda_item.cpp.

References GetBoundingBox().

Referenced by EDIT_TOOL::doMoveSelection(), and PCB_SHAPE::ViewBBox().

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects if there is no #PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters

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

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

Definition at line 123 of file view_item.h.

References VIEW.

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

◆ ViewGetLayers()

std::vector< int > BOARD_ITEM::ViewGetLayers ( ) const

overridevirtualinherited

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

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

Reimplemented from EDA_ITEM.

Reimplemented in FOOTPRINT, PAD, PCB_BOARD_OUTLINE, PCB_CONSTRAINT, PCB_DIMENSION_BASE, PCB_DRILL_MAP, PCB_GRID_ITEM, PCB_GROUP, PCB_MARKER, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA, PCB_VIA_STACK, PCB_VIA_STITCH, and ZONE.

Definition at line 293 of file board_item.cpp.

References IsLocked(), LAYER_LOCKED_ITEM_SHADOW, and m_layer.

◆ ViewGetLOD()

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

overridevirtualinherited

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

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

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

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

Parameters

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

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

Reimplemented from KIGFX::VIEW_ITEM.

Definition at line 661 of file pcb_table.cpp.

References KIGFX::VIEW::IsLayerVisibleCached(), LAYER_LOCKED_ITEM_SHADOW, KIGFX::VIEW_ITEM::LOD_HIDE, KIGFX::VIEW_ITEM::LOD_SHOW, and BOARD_ITEM::m_layer.

◆ viewPrivData()

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

inlineinherited

◆ Visit()

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

overridevirtual

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 244 of file pcb_drill_chart.cpp.

References CONTINUE, PCB_TABLE::GetCells(), PCB_DRILL_CHART_T, PCB_TABLE_T, PCB_TABLECELL_T, and QUIT.

Referenced by BOOST_AUTO_TEST_CASE().

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 159 of file eda_item.h.

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

Member Data Documentation

◆ LOD_HIDE

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

staticconstexprprotectedinherited

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

Definition at line 176 of file view_item.h.

Referenced by lodScaleForThreshold(), KIGFX::VIEW_GROUP::ViewDraw(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_BARCODE::ViewGetLOD(), PCB_DIMENSION_BASE::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GRID_ITEM::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TABLE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ LOD_SHOW

double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

staticconstexprprotectedinherited

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

Definition at line 181 of file view_item.h.

Referenced by lodScaleForThreshold(), FOOTPRINT::ViewGetLOD(), GERBER_DRAW_ITEM::ViewGetLOD(), ViewGetLOD(), PAD::ViewGetLOD(), PCB_BARCODE::ViewGetLOD(), PCB_DIMENSION_BASE::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GRID_ITEM::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TABLE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), PCB_VIA::ViewGetLOD(), SCH_GROUP::ViewGetLOD(), SCH_LINE::ViewGetLOD(), and ZONE::ViewGetLOD().

◆ m_boardCacheOwner

BOARD* BOARD_ITEM::m_boardCacheOwner = nullptr

mutableprotectedinherited

Definition at line 576 of file board_item.h.

Referenced by BOARD::CacheAndReturnItemById(), BOARD::CacheItemById(), BOARD::ClearItemByIdCache(), IsIndexedInBoard(), SetUuid(), BOARD::UncacheItemById(), BOARD::UncacheItemByPtr(), and ~BOARD_ITEM().

◆ m_borderStroke

STROKE_PARAMS PCB_TABLE::m_borderStroke

protectedinherited

Definition at line 327 of file pcb_table.h.

Referenced by CopyFrom(), Deserialize(), GetBorderColor(), GetBorderStroke(), GetBorderStyle(), GetBorderWidth(), operator==(), PCB_TABLE(), PCB_TABLE(), Serialize(), SetBorderColor(), SetBorderStroke(), SetBorderStyle(), SetBorderWidth(), Similarity(), and swapData().

◆ m_builtGeneration

uint64_t PCB_DRILL_CHART::m_builtGeneration

private

Definition at line 190 of file pcb_drill_chart.h.

Referenced by GetBuiltGeneration(), PCB_DRILL_CHART(), PCB_DRILL_CHART(), RebuildCells(), and swapData().

◆ m_cells

std::vector<PCB_TABLECELL*> PCB_TABLE::m_cells

protectedinherited

Definition at line 335 of file pcb_table.h.

Referenced by AddCell(), ClearCells(), CopyFrom(), DeleteMarkedCells(), Deserialize(), Flip(), GetBoundingBox(), GetCell(), GetCells(), GetPosition(), GetRowCount(), InsertCell(), PCB_DRILL_CHART::migrateRows(), Mirror(), Move(), Normalize(), OnFootprintRescaled(), OnFootprintTransformed(), operator==(), PCB_TABLE(), ResizeCells(), Rotate(), RunOnChildren(), Serialize(), SetLayer(), Similarity(), swapData(), TransformGraphicItemsToPolySet(), TransformShapeToPolygon(), Visit(), and ~PCB_TABLE().

◆ m_colCount

int PCB_TABLE::m_colCount

protectedinherited

Definition at line 332 of file pcb_table.h.

Referenced by CopyFrom(), Deserialize(), GetCell(), GetColCount(), GetItemDescription(), GetMsgPanelInfo(), GetRowCount(), PCB_TABLE(), PCB_TABLE(), ResizeCells(), Serialize(), SetColCount(), and swapData().

◆ m_columns

std::vector<DRILL_CHART_COLUMN> PCB_DRILL_CHART::m_columns

private

Definition at line 180 of file pcb_drill_chart.h.

Referenced by ApplyTemplate(), Columns(), Columns(), Deserialize(), operator==(), PCB_DRILL_CHART(), RebuildCells(), Serialize(), and swapData().

◆ m_colWidths

std::map<int, int> PCB_TABLE::m_colWidths

protectedinherited

Definition at line 333 of file pcb_table.h.

Referenced by CopyFrom(), Deserialize(), Flip(), GetColWidth(), Normalize(), operator==(), PCB_TABLE(), SetColWidth(), Similarity(), and swapData().

◆ m_customProperties

std::map<wxString, wxString> EDA_ITEM::m_customProperties

protectedinherited

Definition at line 615 of file eda_item.h.

Referenced by ClearCustomProperties(), GetCustomProperties(), GetCustomPropertiesAsInspectables(), GetCustomProperty(), HasCustomProperties(), operator=(), RemoveConflictingCustomProperties(), RemoveCustomProperty(), SetCustomProperties(), SetCustomProperty(), LIB_SYMBOL::SetParent(), PCB_BARCODE::swapData(), PCB_REFERENCE_IMAGE::swapData(), PCB_SHAPE::swapData(), PCB_TABLE::swapData(), and SCH_ITEM::SwapItemData().

◆ m_dynamicCustomPropsCache

std::map<wxString, std::unique_ptr<PROPERTY_BASE> > EDA_ITEM::m_dynamicCustomPropsCache

mutableprotectedinherited

Per-key cache of dynamic property descriptors for m_customProperties, owned by this object.

Mirrors the per-object field-property caches used by FOOTPRINT / SCH_SYMBOL / SCH_SHEET; entries linger after a key is removed but are simply not enumerated.

Definition at line 621 of file eda_item.h.

Referenced by GetCustomPropertiesAsInspectables(), and RemoveCustomProperty().

◆ m_filter

DRILL_CHART_FILTER PCB_DRILL_CHART::m_filter

private

Definition at line 178 of file pcb_drill_chart.h.

Referenced by buildGroups(), Deserialize(), Filter(), Filter(), operator==(), PCB_DRILL_CHART(), Serialize(), and swapData().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 606 of file eda_item.h.

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

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 206 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 612 of file eda_item.h.

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

◆ m_group

EDA_GROUP* EDA_ITEM::m_group

protectedinherited

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

Definition at line 608 of file eda_item.h.

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

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 204 of file view_item.h.

Referenced by IsBOARD_ITEM(), and VIEW_ITEM().

◆ m_isKnockout

bool BOARD_ITEM::m_isKnockout

protectedinherited

Definition at line 572 of file board_item.h.

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

◆ m_isLocked

bool BOARD_ITEM::m_isLocked

protectedinherited

Definition at line 573 of file board_item.h.

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

◆ m_isRollover

bool EDA_ITEM::m_isRollover

protectedinherited

Definition at line 611 of file eda_item.h.

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

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 203 of file view_item.h.

Referenced by IsSCH_ITEM(), and VIEW_ITEM().

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 571 of file board_item.h.

Referenced by PCB_BARCODE::AssembleBarcode(), BOARD_ITEM(), BOARD_ITEM(), PCB_BARCODE::computeCacheKey(), PCB_BARCODE::Deserialize(), FOOTPRINT::FOOTPRINT(), PCB_BARCODE::GetBoundingHull(), PCB_VIA::GetDrillConstraint(), GetLayer(), FOOTPRINT::GetLayer(), PCB_GENERATOR::GetLayer(), PCB_SHAPE::GetLayer(), GetLayerName(), GetLayerSet(), PCB_SHAPE::GetLayerSet(), PCB_TRACK::GetLayerSet(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PAD::GetPrincipalLayer(), PCB_SHAPE::GetSolderMaskExpansion(), PCB_TRACK::GetSolderMaskExpansion(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), IsOnLayer(), PCB_SHAPE::IsOnLayer(), PCB_TRACK::IsOnLayer(), IsSideSpecific(), PCB_SHAPE::IsType(), operator=(), PCB_ARC::operator==(), PCB_REFERENCE_IMAGE::operator==(), PCB_SHAPE::operator==(), PCB_TARGET::operator==(), PCB_TRACK::operator==(), PCB_VIA::operator==(), PCB_BARCODE::PCB_BARCODE(), PCB_DIMENSION_BASE::PCB_DIMENSION_BASE(), PCB_TARGET::PCB_TARGET(), PCB_TARGET::PCB_TARGET(), PCB_POINT::Serialize(), PCB_REFERENCE_IMAGE::Serialize(), SetLayer(), PCB_BARCODE::SetLayer(), PCB_GENERATOR::SetLayer(), PCB_TABLE::SetLayer(), PAD::SetLayerSet(), PCB_ARC::Similarity(), PCB_REFERENCE_IMAGE::Similarity(), PCB_TRACK::Similarity(), PCB_VIA::Similarity(), PCB_DIMENSION_BASE::StyleFromSettings(), PCB_BARCODE::swapData(), PCB_DRILL_MAP::swapData(), PCB_REFERENCE_IMAGE::swapData(), PCB_SHAPE::swapData(), PCB_TABLE::swapData(), PCB_BARCODE::TransformShapeToPolygon(), ViewGetLayers(), FOOTPRINT::ViewGetLayers(), PCB_REFERENCE_IMAGE::ViewGetLayers(), PCB_SHAPE::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), FOOTPRINT::ViewGetLOD(), PCB_BARCODE::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TABLE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), and PCB_TRACK::ViewGetLOD().

◆ m_netHighlighted

bool EDA_ITEM::m_netHighlighted = false

protectedinherited

Definition at line 613 of file eda_item.h.

Referenced by ClearFlags(), IsBrightened(), IsNetHighlighted(), operator=(), SetNetHighlighted(), and LIB_SYMBOL::SetParent().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Owner.

Definition at line 607 of file eda_item.h.

Referenced by PCB_BOARD_OUTLINE::CopyPros(), SCH_FIELD::Deserialize(), SCH_FIELD::DoHypertextAction(), EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetDefaultLayer(), SCH_FIELD::GetDrawRotation(), SCH_FIELD::GetMenuImage(), PAD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_FIELD::GetName(), BOARD_ITEM::GetParent(), GetParent(), SCH_SHEET_PIN::GetParent(), BOARD_ITEM::GetParentAsString(), SCH_FIELD::GetParentPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetShownText(), SCH_FIELD::GetText(), SCH_FIELD::getUnescapedText(), SCH_FIELD::GetUntranslatedName(), SCH_FIELD::HitTest(), SCH_FIELD::IsLocked(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), BOARD_BOUNDING_BOX::operator=(), operator=(), PAD::operator==(), PCB_BOARD_OUTLINE::operator==(), SCH_FIELD::operator==(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_FIELD::Replace(), SCH_ITEM::ResolveText(), SCH_LABEL_BASE::ResolveTextVar(), SCH_FIELD::SCH_FIELD(), SCH_SYMBOL::SCH_SYMBOL(), SCH_FIELD::Serialize(), SetModified(), SetParent(), SCH_FIELD::SetPosition(), SCH_FIELD::SetText(), PAD::Similarity(), PCB_BOARD_OUTLINE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), and PCB_SHAPE::swapData().

◆ m_precision

int PCB_DRILL_CHART::m_precision

private

Definition at line 183 of file pcb_drill_chart.h.

Referenced by ApplyTemplate(), GetPrecision(), operator==(), PCB_DRILL_CHART(), PCB_DRILL_CHART(), RebuildCells(), Serialize(), SetPrecision(), and swapData().

◆ m_rolloverPos

VECTOR2I EDA_ITEM::m_rolloverPos

protectedinherited

Definition at line 610 of file eda_item.h.

Referenced by GetRolloverPos(), and SetIsRollover().

◆ m_rowHeights

std::map<int, int> PCB_TABLE::m_rowHeights

protectedinherited

Definition at line 334 of file pcb_table.h.

Referenced by CopyFrom(), Deserialize(), GetRowHeight(), PCB_DRILL_CHART::migrateRows(), Normalize(), operator==(), PCB_TABLE(), SetRowHeight(), Similarity(), and swapData().

◆ m_rowKeys

std::map<int, std::string> PCB_DRILL_CHART::m_rowKeys

private

Definition at line 187 of file pcb_drill_chart.h.

Referenced by Deserialize(), IsDataRow(), migrateRows(), operator==(), PCB_DRILL_CHART(), RebuildCells(), RowKeys(), RowKeys(), Serialize(), and swapData().

◆ m_rowShapes

std::map<int, int> PCB_DRILL_CHART::m_rowShapes

private

Definition at line 186 of file pcb_drill_chart.h.

Referenced by Deserialize(), operator==(), PCB_DRILL_CHART(), RebuildCells(), RowShapes(), RowShapes(), Serialize(), and swapData().

◆ m_separatorsStroke

STROKE_PARAMS PCB_TABLE::m_separatorsStroke

protectedinherited

Definition at line 330 of file pcb_table.h.

Referenced by CopyFrom(), Deserialize(), GetSeparatorsColor(), GetSeparatorsStroke(), GetSeparatorsStyle(), GetSeparatorsWidth(), operator==(), PCB_TABLE(), PCB_TABLE(), Serialize(), SetSeparatorsColor(), SetSeparatorsStroke(), SetSeparatorsStyle(), SetSeparatorsWidth(), Similarity(), and swapData().

◆ m_showTotals

bool PCB_DRILL_CHART::m_showTotals

private

Definition at line 184 of file pcb_drill_chart.h.

Referenced by ApplyTemplate(), Deserialize(), GetShowTotals(), IsDataRow(), operator==(), PCB_DRILL_CHART(), PCB_DRILL_CHART(), RebuildCells(), Serialize(), SetShowTotals(), and swapData().

◆ m_strokeColumns

bool PCB_TABLE::m_strokeColumns

protectedinherited

Definition at line 329 of file pcb_table.h.

Referenced by CopyFrom(), Deserialize(), operator==(), PCB_TABLE(), PCB_TABLE(), Serialize(), SetStrokeColumns(), Similarity(), StrokeColumns(), and swapData().

◆ m_strokeExternal

bool PCB_TABLE::m_strokeExternal

protectedinherited

Definition at line 325 of file pcb_table.h.

Referenced by CopyFrom(), Deserialize(), operator==(), PCB_TABLE(), PCB_TABLE(), Serialize(), SetStrokeExternal(), Similarity(), StrokeExternal(), and swapData().

◆ m_StrokeHeaderSeparator

bool PCB_TABLE::m_StrokeHeaderSeparator

protectedinherited

Definition at line 326 of file pcb_table.h.

Referenced by CopyFrom(), Deserialize(), operator==(), PCB_TABLE(), PCB_TABLE(), Serialize(), SetStrokeHeaderSeparator(), Similarity(), StrokeHeaderSeparator(), and swapData().

◆ m_strokeRows

bool PCB_TABLE::m_strokeRows

protectedinherited

Definition at line 328 of file pcb_table.h.

Referenced by CopyFrom(), Deserialize(), operator==(), PCB_TABLE(), PCB_TABLE(), Serialize(), SetStrokeRows(), Similarity(), StrokeRows(), and 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.

Definition at line 603 of file eda_item.h.

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

◆ m_symbolColumn

int PCB_DRILL_CHART::m_symbolColumn

private

Definition at line 188 of file pcb_drill_chart.h.

Referenced by Deserialize(), GetSymbolColumn(), operator==(), PCB_DRILL_CHART(), PCB_DRILL_CHART(), RebuildCells(), Serialize(), SetSymbolColumn(), and swapData().

◆ m_units

DRILL_CHART_UNITS PCB_DRILL_CHART::m_units

private

Definition at line 182 of file pcb_drill_chart.h.

Referenced by ApplyTemplate(), Deserialize(), GetUnits(), operator==(), PCB_DRILL_CHART(), PCB_DRILL_CHART(), RebuildCells(), Serialize(), SetUnits(), and swapData().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 597 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 205 of file view_item.h.

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

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

Definition at line 232 of file board_item.h.

Referenced by BOARD::GetPosition().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

Constructor & Destructor Documentation

◆ PCB_DRILL_CHART() [1/2]

◆ PCB_DRILL_CHART() [2/2]

◆ ~PCB_DRILL_CHART()

Member Function Documentation

◆ Add()

◆ AddCell()

◆ ApplyTemplate()

◆ Autosize()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ buildGroups()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearCells()

◆ ClearCustomProperties()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Columns() [1/2]

◆ Columns() [2/2]

◆ Compare()

◆ CopyFrom()

◆ Delete()

◆ DeleteMarkedCells()

◆ DeleteStructure()

◆ Deserialize()

◆ DisambiguateItemDescription()

◆ DrawBorders()

◆ Duplicate()

◆ Filter() [1/2]

◆ Filter() [2/2]

◆ findParent()

◆ FitsEnabledLayers()

◆ Flip()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBorderColor()

◆ GetBorderStroke()

◆ GetBorderStyle()

◆ GetBorderWidth()

◆ GetBoundingBox()

◆ GetBuiltGeneration()

◆ GetCell()

◆ GetCells()

◆ GetCenter()

◆ GetClass()

◆ GetColCount()

◆ GetColWidth()

◆ GetCustomProperties()

◆ GetCustomPropertiesAsInspectables()

◆ GetCustomProperty()

◆ GetDynamicProperties()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveShape()

◆ GetEmbeddedFiles()

◆ GetEmbeddedFonts()

◆ GetEnd()

◆ GetFlags()