#include <pcb_barcode.h>

Inheritance diagram for PCB_BARCODE:

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

Public Member Functions
	PCB_BARCODE (BOARD_ITEM *aParent)
	Construct a PCB_BARCODE.

	~PCB_BARCODE ()
	Destructor.

VECTOR2I	GetPosition () const override
	Get the position (center) of the barcode in internal units.

void	SetPosition (const VECTOR2I &aPos) override

void	SetTextSize (int aTextSize)
	Change the height of the human-readable text displayed below the barcode.

int	GetTextSize () const

void	SetLayer (PCB_LAYER_ID aLayer) override
	Set the drawing layer for the barcode and its text.

int	GetWidth () const
	Get the barcode width (in internal units).

void	SetWidth (int aWidth)

int	GetHeight () const
	Get the barcode height (in internal units).

void	SetHeight (int aHeight)

const VECTOR2I &	GetMargin () const
	Get the barcode margin (in internal units).

void	SetMargin (const VECTOR2I &aMargin)

const SHAPE_POLY_SET &	GetPolyShape () const
	Access the underlying polygonal representation generated for the barcode.

const SHAPE_POLY_SET &	GetSymbolPoly () const
	Access the cached polygon for the barcode symbol only (no text, no margins/knockout).

const SHAPE_POLY_SET &	GetTextPoly () const
	Access the cached polygon for the human-readable text only (already scaled/placed).

void	TransformShapeToPolygon (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc=ERROR_INSIDE, bool ignoreLineWidth=false) const override
	Convert the barcode (text + symbol shapes) to polygonal geometry suitable for filling/collision tests.

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

void	GetBoundingHull (SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc=ERROR_INSIDE) const

void	ComputeBarcode ()
	Generate the internal polygon representation for the current barcode text, kind and error correction.

void	ComputeTextPoly ()
	Generate the internal polygon representation for the human-readable text.

void	AssembleBarcode ()
	Assemble the barcode polygon and text polygons into a single polygonal representation.

void	SetText (const wxString &aText)
	Set the barcode content text to encode.

wxString	GetText () const

wxString	GetShownText () const

PCB_TEXT &	Text ()
	Access the internal `PCB_TEXT` object used for showing the human-readable text.

const PCB_TEXT &	Text () const

void	Move (const VECTOR2I &offset) override
	Function Move.

void	Rotate (const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
	Rotate the barcode around a given centre by the given angle.

void	Flip (const VECTOR2I &aCentre, FLIP_DIRECTION aFlipLeftRight) override
	Flip the barcode horizontally or vertically around a centre point.

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

VECTOR2I	GetCenter () const override
	Get the centre of the barcode (alias for GetPosition).

void	SetRect (const VECTOR2I &aTopLeft, const VECTOR2I &aBotRight)
	Set the bounding rectangle of the barcode.

void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Populate message panel information entries (e.g.

bool	HitTest (const VECTOR2I &aPosition, int aAccuracy) const override
	Hit-test a point against the barcode (text and symbol area).

bool	HitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
	Hit-test a rectangle against the barcode bounding area.

wxString	GetClass () const override
	Return the class name for display/debugging purposes.

const BOX2I	GetBoundingBox () const override
	Get the axis-aligned bounding box of the barcode including text.

wxString	GetItemDescription (UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
	Produce a short human-readable description of the item for UI lists.

BITMAPS	GetMenuImage () const override
	Icon to show in context menus/toolbars for this item type.

EDA_ITEM *	Clone () const override
	Create a copy of this item.

void	swapData (BOARD_ITEM *aImage) override

virtual const BOX2I	ViewBBox () const override
	Get the bbox used for drawing/view culling, may include additional view-only extents.

double	Similarity (const BOARD_ITEM &aItem) const override
	Compute a simple similarity score between this barcode and another board item.

bool	operator== (const BOARD_ITEM &aItem) const override
	Equality comparison operator for board-level deduplication.

BARCODE_T	GetKind () const
	Returns the type of the barcode (QR, CODE_39, etc.).

void	SetKind (BARCODE_T aKind)

void	SetBarcodeKind (BARCODE_T aKind)

bool	KeepSquare () const

void	SetErrorCorrection (BARCODE_ECC_T aErrorCorrection)
	Set the error correction level used for QR codes.

BARCODE_ECC_T	GetErrorCorrection () const

void	SetBarcodeErrorCorrection (BARCODE_ECC_T aErrorCorrection)

void	SetBarcodeText (const wxString &aText)

void	SetShowText (bool aShow)

bool	GetShowText () const

void	SetBarcodeWidth (int aWidth)

void	SetBarcodeHeight (int aHeight)

EDA_ANGLE	GetAngle () const

double	GetOrientation () const

void	SetOrientation (double aDegrees)

int	GetMarginX () const

int	GetMarginY () const

void	SetMarginX (int aX)

void	SetMarginY (int aY)

bool	IsKnockout () const override

void	SetIsKnockout (bool aEnable) override

virtual void	CopyFrom (const BOARD_ITEM *aOther)

bool	IsGroupableType () const

int	GetX () const

int	GetY () const

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

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

BOARD_ITEM_CONTAINER *	GetParent () const

FOOTPRINT *	GetParentFootprint () const

VECTOR2I	GetFPRelativePosition () const

void	SetFPRelativePosition (const VECTOR2I &aPos)

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

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

const KIFONT::METRICS &	GetFontMetrics () const

virtual 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

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

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.

bool	IsLocked () const override

void	SetLocked (bool aLocked) override

int	GetMaxError () const

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

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

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

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

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

virtual BOARD *	GetBoard ()

wxString	GetParentAsString () const
	For "parent" property.

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

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

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

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

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

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetIsRollover (bool aIsRollover)

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

virtual void	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

virtual void	ClearTempFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

virtual wxString	GetFriendlyName () const

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

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

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

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

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

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

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

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

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

virtual EMBEDDED_FILES *	GetEmbeddedFiles ()

bool	IsSCH_ITEM () const

bool	IsBOARD_ITEM () const

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

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

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

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

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

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

Static Public Member Functions
static bool	ClassOf (const EDA_ITEM *aItem)
	Type-check helper.

static int	Compare (const PCB_BARCODE aBarcode, const PCB_BARCODE 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
virtual wxString	layerMaskDescribe () const
	Return a string (to be shown to the user) describing a layer mask.

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
PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

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.

bool	m_forceVisible

bool	m_isRollover

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

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

Private Attributes
int	m_width
	Barcode width.

int	m_height
	Barcode height.

VECTOR2I	m_pos
	Position of the barcode.

VECTOR2I	m_margin
	Margin around the barcode (only valid for knockout)

PCB_TEXT	m_text

BARCODE_T	m_kind

EDA_ANGLE	m_angle

BARCODE_ECC_T	m_errorCorrection
	Error correction level for QR codes.

SHAPE_POLY_SET	m_poly
	Full geometry (barcode + optional text or knockout)

SHAPE_POLY_SET	m_symbolPoly
	Barcode symbol only (cached, centered at origin)

SHAPE_POLY_SET	m_textPoly
	Human-readable text only (cached, centered/positioned)

BOX2I	m_bbox
	BBox of m_poly (ie: barcode + text)

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

bool	m_isSCH_ITEM

bool	m_isBOARD_ITEM

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items.

Detailed Description

Definition at line 63 of file pcb_barcode.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum BOARD_ITEM::COMPARE_FLAGS : int

inherited

Enumerator
DRC
INSTANCE_TO_INSTANCE

Definition at line 433 of file board_item.h.

Constructor & Destructor Documentation

◆ PCB_BARCODE()

PCB_BARCODE::PCB_BARCODE ( BOARD_ITEM * aParent )

Construct a PCB_BARCODE.

Parameters

aParent Parent board item (usually the BOARD object).

Definition at line 53 of file pcb_barcode.cpp.

References BOARD_ITEM::BOARD_ITEM(), Dwgs_User, L, m_angle, m_errorCorrection, m_height, m_kind, BOARD_ITEM::m_layer, m_pos, m_text, m_width, PCB_BARCODE_T, pcbIUScale, and QR_CODE.

Referenced by Clone(), Compare(), operator==(), Similarity(), and swapData().

◆ ~PCB_BARCODE()

PCB_BARCODE::~PCB_BARCODE ( )

Destructor.

Definition at line 67 of file pcb_barcode.cpp.

Member Function Documentation

◆ AssembleBarcode()

void PCB_BARCODE::AssembleBarcode ( )

Assemble the barcode polygon and text polygons into a single polygonal representation.

Optionally apply a knockout and margins.

Definition at line 166 of file pcb_barcode.cpp.

References SHAPE_POLY_SET::AddOutline(), SHAPE_LINE_CHAIN::Append(), SHAPE_POLY_SET::BooleanSubtract(), ComputeBarcode(), ComputeTextPoly(), SHAPE_POLY_SET::Fracture(), BOARD_ITEM::GetBoard(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), BOX2< Vec >::Inflate(), IsBackLayer(), IsKnockout(), BOARD_ITEM::IsSideSpecific(), LEFT_RIGHT, m_angle, m_bbox, m_height, BOARD_ITEM::m_layer, m_margin, m_poly, m_pos, m_symbolPoly, m_text, m_textPoly, m_width, pcbIUScale, SHAPE_LINE_CHAIN::SetClosed(), and SetRect().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Flip(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), Rotate(), SetBarcodeErrorCorrection(), SetBarcodeHeight(), SetBarcodeKind(), SetBarcodeText(), SetBarcodeWidth(), SetIsKnockout(), SetLayer(), SetMarginX(), SetMarginY(), SetShowText(), SetTextSize(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

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

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

Referenced by PAD::ClearZoneLayerOverrides(), PCB_VIA::ClearZoneLayerOverrides(), PAD::Flip(), PCB_VIA::GetLayerSet(), PAD::PAD(), PCB_VIA::PCB_VIA(), PADSTACK::RelevantShapeLayers(), 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 148 of file board_item.cpp.

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

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

Referenced by ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper().

◆ ClassOf()

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

inlinestatic

Type-check helper.

Returns: true if the given EDA_ITEM is a PCB_BARCODE.

Definition at line 86 of file pcb_barcode.h.

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

Referenced by operator==(), and Similarity().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 138 of file eda_item.h.

References BRIGHTENED, and ClearFlags().

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

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 156 of file eda_item.h.

References ClearFlags(), and GetEditFlags().

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 144 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, and m_flags.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 137 of file eda_item.h.

References ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 169 of file eda_item.h.

References ClearFlags(), and GetTempFlags().

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

◆ Clone()

EDA_ITEM * PCB_BARCODE::Clone ( ) const

overridevirtual

Create a copy of this item.

The returned pointer is owned by the caller.

Returns: newly allocated EDA_ITEM pointer that is a copy of this object.

Reimplemented from EDA_ITEM.

Definition at line 602 of file pcb_barcode.cpp.

References BOARD_ITEM::CopyFrom(), EDA_ITEM::EDA_ITEM(), m_text, PCB_BARCODE(), and EDA_ITEM::SetParent().

◆ Compare()

int PCB_BARCODE::Compare	(	const PCB_BARCODE *	aBarcode,
		const PCB_BARCODE *	aOther )

static

Definition at line 651 of file pcb_barcode.cpp.

References GetErrorCorrection(), GetHeight(), GetKind(), GetPosition(), GetText(), GetTextSize(), GetWidth(), PCB_BARCODE(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ ComputeBarcode()

void PCB_BARCODE::ComputeBarcode ( )

Generate the internal polygon representation for the current barcode text, kind and error correction.

This uses the Zint backend to encode the text and populate m_poly. After calling this the barcode bounding box and polygon are available and scaled to the current width/height.

Definition at line 254 of file pcb_barcode.cpp.

References SHAPE_LINE_CHAIN::Append(), CODE_128, CODE_39, DATA_MATRIX, GetText(), KiROUND(), m_errorCorrection, m_kind, M_PI, m_symbolPoly, MICRO_QR_CODE, QR_CODE, SHAPE_LINE_CHAIN::SetClosed(), text, and to_underlying().

Referenced by AssembleBarcode().

◆ ComputeTextPoly()

void PCB_BARCODE::ComputeTextPoly ( )

Generate the internal polygon representation for the human-readable text.

This uses the internal PCB_TEXT object to generate the text polygon and position it below the barcode symbol. The resulting polygon is stored in m_textPoly.

Definition at line 224 of file pcb_barcode.cpp.

References SHAPE_POLY_SET::BBox(), ERROR_INSIDE, BOX2< Vec >::GetBottom(), BOX2< Vec >::GetCenter(), BOARD_ITEM::GetMaxError(), BOX2< Vec >::GetTop(), m_symbolPoly, m_text, m_textPoly, SHAPE_POLY_SET::Move(), SHAPE_POLY_SET::OutlineCount(), pcbIUScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by AssembleBarcode().

◆ CopyFrom()

void BOARD_ITEM::CopyFrom ( const BOARD_ITEM * aOther )

virtualinherited

Reimplemented in FOOTPRINT, PAD, PCB_ARC, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 73 of file board_item.cpp.

References BOARD_ITEM().

Referenced by PCB_BARCODE::Clone(), and API_HANDLER_PCB::handleCreateUpdateItemsInternal().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 254 of file board_item.cpp.

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

◆ Deserialize()

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

virtualinherited

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 in BOARD_STACKUP, EDA_SHAPE, EDA_TEXT, FOOTPRINT, NETCLASS, PAD, PADSTACK, PCB_ARC, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_DIMENSION_BASE, PCB_FIELD, PCB_GROUP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LABEL, SCH_LINE, and ZONE.

Definition at line 30 of file serializable.cpp.

Referenced by ~SERIALIZABLE().

◆ Duplicate()

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

virtualinherited

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 in FOOTPRINT.

Definition at line 284 of file board_item.cpp.

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

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

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 75 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().

◆ Flip()

void PCB_BARCODE::Flip	(	const VECTOR2I &	aCentre,
		FLIP_DIRECTION	aFlipLeftRight )

overridevirtual

Flip the barcode horizontally or vertically around a centre point.

The layer may be adjusted when flipping.

Parameters

aCentre	flip origin in internal units.
aFlipLeftRight	flip direction enum.

Reimplemented from BOARD_ITEM.

Definition at line 147 of file pcb_barcode.cpp.

References ANGLE_180, AssembleBarcode(), FlipLayer(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayer(), m_angle, m_pos, MIRROR(), SetLayer(), and TOP_BOTTOM.

◆ Get() [1/3]

template<typename T>

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

inlineinherited

Definition at line 148 of file inspectable.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 128 of file inspectable.h.

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

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

◆ Get() [3/3]

template<typename T>

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 136 of file inspectable.h.

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

◆ GetAngle()

EDA_ANGLE PCB_BARCODE::GetAngle ( ) const

inline

Definition at line 373 of file pcb_barcode.h.

References m_angle.

Referenced by BOOST_AUTO_TEST_CASE(), PCB_IO_KICAD_SEXPR::format(), hash_fp_item(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 89 of file board_item.cpp.

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

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), BOARD_ADAPTER::addShape(), PCB_BARCODE::AssembleBarcode(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BoardCopperLayerCount(), BoardLayerCount(), BoardLayerSet(), CN_CONNECTIVITY_ALGO::Build(), FOOTPRINT::BuildNetTieCache(), ZONE::BuildSmoothedPoly(), collidesWithArea(), PCB_TUNING_PATTERN::CreateNew(), PCB_GROUP::Deserialize(), BOARD_INSPECTION_TOOL::DiffFootprint(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), enclosedByAreaFunc(), existsOnLayerFunc(), ZONE_FILLER::Fill(), PAD::FlashLayer(), PCB_VIA::FlashLayer(), FOOTPRINT::Flip(), PAD::Flip(), PCB_ARC::Flip(), PCB_BARCODE::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_GENERATOR::Flip(), PCB_POINT::Flip(), PCB_SHAPE::Flip(), PCB_TABLE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), PCB_VIA::Flip(), ZONE::Flip(), FOOTPRINT::FootprintNeedsUpdate(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), fromToFunc(), FOOTPRINT::GetBoundingBox(), NETINFO_ITEM::GetBoundingBox(), ZONE::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), FOOTPRINT::GetBoundingHull(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TRACK::GetDelay(), BOARD_CONNECTED_ITEM::GetDisplayNetname(), PCB_VIA::GetDrillConstraint(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), GetEmbeddedFonts(), getFieldFunc(), ZONE::GetInteractingZones(), PAD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), ZONE::GetItemDescription(), FOOTPRINT::GetLayerBoundingBox(), GetLayerName(), GetMaxError(), PCB_VIA::GetMinAnnulus(), PCB_TRACK::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), PCB_VIA::GetOutermostConnectedLayers(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetOwnClearance(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_MARKER::GetSeverity(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), FOOTPRINT::GetSide(), PAD::GetSolderMaskExpansion(), PCB_SHAPE::GetSolderMaskExpansion(), PCB_TRACK::GetSolderMaskExpansion(), PCB_VIA::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), inDiffPairFunc(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), isCoupledDiffPairFunc(), IsLocked(), IsSideSpecific(), PCB_VIA::IsTented(), layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), ZONE::Move(), CN_VISITOR::operator()(), PCB_IO_EAGLE::packageWire(), padNeedsUpdate(), PCB_TABLECELL::PCB_TABLECELL(), PCB_TUNING_PATTERN::recoverBaseline(), BOARD::ResolveDRCExclusions(), FOOTPRINT::ResolveTextVar(), PCB_SHAPE::SetIsProxyItem(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_TUNING_PATTERN::SetNetCode(), PCB_DIMENSION_BASE::SetUnitsMode(), PCB_FIELDS_GRID_TABLE::SetValueAsLong(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), BOARD_CONNECTED_ITEM::UnpackNet(), PCB_SHAPE::UpdateHatching(), BOARD::UpdateRatsnestExclusions(), FOOTPRINT::ViewBBox(), PAD::ViewBBox(), PCB_TRACK::ViewBBox(), PAD::ViewGetLayers(), PCB_VIA::ViewGetLayers(), PAD::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_VIA::ViewGetLOD(), ZONE::ZONE(), zoneNeedsUpdate(), FOOTPRINT::~FOOTPRINT(), and ZONE::~ZONE().

◆ GetBoundingBox()

const BOX2I PCB_BARCODE::GetBoundingBox ( ) const

overridevirtual

Get the axis-aligned bounding box of the barcode including text.

Returns: bounding BOX2I in internal units.

Reimplemented from EDA_ITEM.

Definition at line 455 of file pcb_barcode.cpp.

References m_bbox.

Referenced by HitTest(), and HitTest().

◆ GetBoundingHull()

void PCB_BARCODE::GetBoundingHull	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aMaxError,
		ERROR_LOC	aErrorLoc = ERROR_INSIDE ) const

Definition at line 508 of file pcb_barcode.cpp.

References SHAPE_POLY_SET::Append(), BOX2< Vec >::GetBottom(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetRight(), m_angle, BOARD_ITEM::m_layer, m_pos, m_symbolPoly, m_textPoly, SHAPE_POLY_SET::NewOutline(), RotatePoint(), UNDEFINED_LAYER, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by ZONE_FILLER::addKnockout(), KIGFX::PCB_PAINTER::draw(), HitTest(), CONVERT_TOOL::makePolysFromClosedGraphics(), and PNS_KICAD_IFACE_BASE::syncBarcode().

◆ GetCenter()

VECTOR2I PCB_BARCODE::GetCenter ( ) const

inlineoverridevirtual

Get the centre of the barcode (alias for GetPosition).

Reimplemented from BOARD_ITEM.

Definition at line 246 of file pcb_barcode.h.

References GetPosition().

◆ GetClass()

wxString PCB_BARCODE::GetClass ( ) const

inlineoverridevirtual

Return the class name for display/debugging purposes.

Implements KIGFX::VIEW_ITEM.

Definition at line 287 of file pcb_barcode.h.

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveHoleShape()

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

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 337 of file board_item.cpp.

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

Referenced by collidesWithArea(), DRAWING_TOOL::DrawVia(), DRC_RTREE::Insert(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), 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_BARCODE::GetEffectiveShape	(	PCB_LAYER_ID	aLayer = UNDEFINED_LAYER,
		FLASHING	aFlash = FLASHING::DEFAULT ) const

overridevirtual

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

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

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 499 of file pcb_barcode.cpp.

References ERROR_INSIDE, and TransformShapeToPolygon().

◆ GetEmbeddedFiles()

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )

inlinevirtualinherited

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

Definition at line 468 of file eda_item.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::Parse().

◆ GetEmbeddedFonts()

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

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 402 of file board_item.cpp.

References GetBoard().

◆ GetErrorCorrection()

BARCODE_ECC_T PCB_BARCODE::GetErrorCorrection ( ) const

inline

Definition at line 363 of file pcb_barcode.h.

References m_errorCorrection.

Referenced by barcodeNeedsUpdate(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compare(), PCB_IO_KICAD_SEXPR::format(), hash_fp_item(), and PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 145 of file eda_item.h.

References m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), PCB_TABLE::DeleteMarkedCells(), SCH_TABLE::DeleteMarkedCells(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::EditCancel(), PCB_TUNING_PATTERN::EditFinish(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), SCH_SELECTION_TOOL::filterCollectorForHierarchy(), findNext(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD::Recombine(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and PCB_TUNING_PATTERN::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 279 of file eda_item.h.

References GetPosition().

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

◆ GetFontMetrics()

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

inherited

Definition at line 133 of file board_item.cpp.

References KIFONT::METRICS::Default().

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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 171 of file view_item.h.

References m_forcedTransparency.

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

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 347 of file board_item.cpp.

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

Referenced by PCB_IO_IPC2581::addLocationNode(), EDA_DATA::PACKAGE::AddPin(), PCB_IO_KICAD_SEXPR::format(), PCB_FIELDS_GRID_TABLE::GetValue(), 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, SCH_FIELD, SCH_LINE, SCH_PIN, SCH_RULE_AREA, SCH_TEXT, and ZONE.

Definition at line 401 of file eda_item.cpp.

References GetTypeDesc().

Referenced by API_HANDLER_PCB::createItemForType(), API_HANDLER_SCH::createItemForType(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), and PROPERTIES_PANEL::rebuildProperties().

◆ GetHeight()

int PCB_BARCODE::GetHeight ( ) const

inline

Get the barcode height (in internal units).

Definition at line 121 of file pcb_barcode.h.

References m_height.

Referenced by barcodeNeedsUpdate(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compare(), PCB_IO_KICAD_SEXPR::format(), hash_fp_item(), and PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ GetItemDescription()

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

overridevirtual

Produce a short human-readable description of the item for UI lists.

Parameters

aUnitsProvider	unit conversion helper (may be null).
aFull	if true produce a more verbose description.

Returns: localized description string.

Reimplemented from EDA_ITEM.

Definition at line 461 of file pcb_barcode.cpp.

References _, BOARD_ITEM::GetLayerName(), and GetText().

◆ GetKind()

BARCODE_T PCB_BARCODE::GetKind ( ) const

inline

Returns the type of the barcode (QR, CODE_39, etc.).

Definition at line 346 of file pcb_barcode.h.

References m_kind.

Referenced by barcodeNeedsUpdate(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compare(), PCB_IO_KICAD_SEXPR::format(), hash_fp_item(), and PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in FOOTPRINT, PAD, PCB_BOARD_OUTLINE, PCB_SHAPE, PCB_TUNING_PATTERN, PCB_VIA, and ZONE.

Definition at line 232 of file board_item.h.

References m_layer.

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

References 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_GROUP, PCB_SHAPE, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 252 of file board_item.h.

References m_layer, and UNDEFINED_LAYER.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), PCB_GRID_HELPER::BestSnapAnchor(), collidesWithArea(), PCB_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::computeAnchors(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRules(), existsOnLayerFunc(), getBoardNormalizedLayerSet(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), hash_board_item(), BOARD_INSPECTION_TOOL::InspectClearance(), intersectsAreaFunc(), PNS_KICAD_IFACE::IsItemVisible(), isMaskAperture(), IsSideSpecific(), layerMaskDescribe(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), BOARD_ITEM::ptr_cmp::operator()(), CN_VISITOR::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), DRC_ENGINE::ProcessAssertions(), BOARD_COMMIT::propagateDamage(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), BOARD::RemoveAllItemsOnLayer(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), 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().

◆ GetMargin()

const VECTOR2I & PCB_BARCODE::GetMargin ( ) const

inline

Get the barcode margin (in internal units).

Definition at line 127 of file pcb_barcode.h.

References m_margin.

Referenced by hash_fp_item().

◆ GetMarginX()

int PCB_BARCODE::GetMarginX ( ) const

inline

Definition at line 386 of file pcb_barcode.h.

References m_margin.

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ GetMarginY()

int PCB_BARCODE::GetMarginY ( ) const

inline

Definition at line 387 of file pcb_barcode.h.

References m_margin.

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ GetMaxError()

int BOARD_ITEM::GetMaxError ( ) const

inherited

Definition at line 139 of file board_item.cpp.

References ARC_HIGH_DEF, and GetBoard().

Referenced by STEP_PCB_MODEL::AddPadShape(), BOARD_ADAPTER::addShape(), BOARD_ADAPTER::addShape(), BOARD_ADAPTER::addText(), PAD::BuildEffectivePolygon(), PAD::buildEffectiveShape(), EXPORTER_STEP::buildFootprint3DShapes(), EXPORTER_STEP::buildGraphic3DShape(), ZONE::BuildSmoothedPoly(), EXPORTER_STEP::buildTrack3DShape(), FOOTPRINT::CheckNetTies(), PCB_BARCODE::ComputeTextPoly(), BOARD_ADAPTER::createLayers(), BOARD_ADAPTER::createPadWithMargin(), BOARD_ADAPTER::createTrackWithMargin(), PAD::doCheckPad(), PCB_TEXT::GetEffectiveShape(), PCB_SHAPE::getMaxError(), DSN::SPECCTRA_DB::makePADSTACK(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), PAD::MergePrimitivesAsPolygon(), BRDITEMS_PLOTTER::PlotShape(), process(), PNS_KICAD_IFACE_BASE::syncBarcode(), PNS_KICAD_IFACE_BASE::syncTextItem(), and ZONE::TransformSmoothedOutlineToPolygon().

◆ GetMenuImage()

BITMAPS PCB_BARCODE::GetMenuImage ( ) const

overridevirtual

Icon to show in context menus/toolbars for this item type.

Reimplemented from EDA_ITEM.

Definition at line 467 of file pcb_barcode.cpp.

References add_barcode.

◆ GetMsgPanelInfo()

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

overridevirtual

Populate message panel information entries (e.g.

for selection/property panel).

Parameters

aFrame	parent draw frame used for context.
aList	vector to append MSG_PANEL_ITEM entries to.

Reimplemented from EDA_ITEM.

Definition at line 367 of file pcb_barcode.cpp.

References _, KIUI::EllipsizeStatusText(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetParentFootprint(), FOOTPRINT::GetReference(), GetText(), ENUM_MAP< T >::Instance(), BOARD_ITEM::IsLocked(), m_angle, m_kind, m_text, UNITS_PROVIDER::MessageTextFromValue(), and PCB_EDIT_FRAME_NAME.

◆ GetOrientation()

double PCB_BARCODE::GetOrientation ( ) const

inline

Definition at line 374 of file pcb_barcode.h.

References m_angle.

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( ) const

inlineinherited

Definition at line 210 of file board_item.h.

References EDA_ITEM::m_parent.

Referenced by PCB_EDIT_TABLE_TOOL::copyCell(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createTrackWithMargin(), DeleteStructure(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), getClosestGroup(), PCB_TABLECELL::GetColumn(), PCB_TABLECELL::GetColumnWidth(), PCB_TABLECELL::GetParentGroup(), PCB_TABLECELL::GetRow(), PCB_TABLECELL::GetRowHeight(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), memberOfGroupFunc(), EDIT_TOOL::MoveExact(), PAD::operator==(), PAD::PAD(), PAD::PAD(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_BOARD_OUTLINE::PCB_BOARD_OUTLINE(), PCB_FIELD::PCB_FIELD(), PCB_VIA::PCB_VIA(), BRDITEMS_PLOTTER::PlotBarCode(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), PCB_TABLECELL::SetColumnWidth(), PCB_TABLECELL::SetRowHeight(), PAD::Similarity(), PCB_BOARD_OUTLINE::Similarity(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), 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 393 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 98 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_IO_IPC2581::addPadStack(), PCB_CONTROL::AppendBoard(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::DeleteItems(), doPushPadProperties(), KIGFX::PCB_PAINTER::Draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), EDIT_TOOL::Duplicate(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), MULTICHANNEL_TOOL::fixupNet(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), FormatProbeItem(), PCB_IO_IPC2581::generateLayerSetNet(), PAD::GetClearanceOverrides(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TEXT::GetDrawRotation(), PAD::GetFPRelativeOrientation(), GetFPRelativePosition(), PAD::GetItemDescription(), PCB_FIELD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TEXT::GetItemDescription(), PCB_SHAPE::GetMenuImage(), PCB_BARCODE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), PAD::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), PCB_FIELDS_GRID_TABLE::GetValue(), PAD::GetZoneConnectionOverrides(), PCB_SELECTION_TOOL::grabUnconnected(), PCB_GROUP_TOOL::Group(), hasComponentClassFunc(), hash_fp_item(), BOARD::HasItemsOnLayer(), 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(), PCB_SELECTION_TOOL::itemPassesFilter(), memberOfFootprintFunc(), memberOfSheetFunc(), memberOfSheetOrChildrenFunc(), BOARD::Move(), ARRAY_TOOL::onDialogClosed(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), PCB_IO_IPC2581::pinName(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), BRDITEMS_PLOTTER::PlotTableBorders(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PAD_TOOL::pushPadSettings(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GRID_HELPER::queryVisible(), PAD::Recombine(), BOARD::RemoveAllItemsOnLayer(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), PAD::SameLogicalPadAs(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::Selectable(), PAD::SetFPRelativeOrientation(), SetFPRelativePosition(), PCB_FIELDS_GRID_TABLE::SetValue(), PAD::SharesNetTieGroup(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PCB_IO_EAGLE::transferPad(), PCB_SHAPE::UpdateHatching(), PCB_POINT_EDITOR::updateItem(), PAD::ViewGetLayers(), PCB_SHAPE::ViewGetLayers(), PCB_TEXT::ViewGetLayers(), PCB_TEXTBOX::ViewGetLayers(), PCB_FIELD::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and ZONE::ZONE().

◆ GetParentGroup()

virtual EDA_GROUP * EDA_ITEM::GetParentGroup ( ) const

inlinevirtualinherited

Reimplemented in PCB_TABLECELL, and SCH_TABLECELL.

Definition at line 116 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SCH_MOVE_TOOL::doMoveSelection(), BOARD_ITEM::Duplicate(), SCH_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), GENERATOR_TOOL::GENERATOR_TOOL(), getClosestGroup(), getClosestGroup(), PCB_TABLECELL::GetParentGroup(), SCH_TABLECELL::GetParentGroup(), GetParentGroupId(), BOARD_ITEM::IsLocked(), memberOfGroupFunc(), BOARD_EDITOR_CONTROL::modifyLockSelected(), BOARD::Move(), PCB_CONTROL::Paste(), SCH_EDITOR_CONTROL::Paste(), BOARD_COMMIT::Push(), SCH_COMMIT::pushSchEdit(), PNS_KICAD_IFACE::RemoveItem(), PCB_SELECTION_TOOL::Selectable(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), COMMIT::Stage(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), DIALOG_GLOBAL_EDIT_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 91 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

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

◆ GetPolyShape()

const SHAPE_POLY_SET & PCB_BARCODE::GetPolyShape ( ) const

inline

Access the underlying polygonal representation generated for the barcode.

Returns: reference to internal SHAPE_POLY_SET holding outlines for the barcode.

Definition at line 135 of file pcb_barcode.h.

References m_poly.

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

◆ GetPosition()

VECTOR2I PCB_BARCODE::GetPosition ( ) const

overridevirtual

Get the position (center) of the barcode in internal units.

Returns: center position of the barcode.

Reimplemented from EDA_ITEM.

Definition at line 79 of file pcb_barcode.cpp.

References m_pos.

Referenced by barcodeNeedsUpdate(), BOOST_AUTO_TEST_CASE(), Compare(), PCB_IO_KICAD_SEXPR::format(), GetCenter(), hash_fp_item(), operator==(), SetOrientation(), Similarity(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ GetShownText()

wxString PCB_BARCODE::GetShownText ( ) const

Definition at line 97 of file pcb_barcode.cpp.

References m_text.

◆ GetShowText()

bool PCB_BARCODE::GetShowText ( ) const

inline

Definition at line 368 of file pcb_barcode.h.

References m_text.

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_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 288 of file eda_item.h.

References GetPosition().

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 119 of file board_item.cpp.

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

Referenced by CONVERT_TOOL::CreatePolys().

◆ GetSymbolPoly()

const SHAPE_POLY_SET & PCB_BARCODE::GetSymbolPoly ( ) const

inline

Access the cached polygon for the barcode symbol only (no text, no margins/knockout).

Definition at line 140 of file pcb_barcode.h.

References m_symbolPoly.

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 161 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().

◆ GetText()

wxString PCB_BARCODE::GetText ( ) const

Definition at line 91 of file pcb_barcode.cpp.

References m_text.

Referenced by barcodeNeedsUpdate(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compare(), ComputeBarcode(), PCB_IO_KICAD_SEXPR::format(), GetItemDescription(), GetMsgPanelInfo(), operator==(), PCB_BARCODE_DESC::PCB_BARCODE_DESC(), and Similarity().

◆ GetTextPoly()

const SHAPE_POLY_SET & PCB_BARCODE::GetTextPoly ( ) const

inline

Access the cached polygon for the human-readable text only (already scaled/placed).

Definition at line 145 of file pcb_barcode.h.

References m_textPoly.

◆ GetTextSize()

int PCB_BARCODE::GetTextSize ( ) const

Definition at line 121 of file pcb_barcode.cpp.

References m_text.

Referenced by barcodeNeedsUpdate(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compare(), PCB_IO_KICAD_SEXPR::format(), operator==(), PCB_BARCODE_DESC::PCB_BARCODE_DESC(), and Similarity().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

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

Definition at line 392 of file eda_item.cpp.

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

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

◆ GetWidth()

int PCB_BARCODE::GetWidth ( ) const

inline

Get the barcode width (in internal units).

Definition at line 115 of file pcb_barcode.h.

References m_width.

Referenced by barcodeNeedsUpdate(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Compare(), PCB_IO_KICAD_SEXPR::format(), hash_fp_item(), and PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 95 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 101 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().

◆ HasDrilledHole()

virtual bool BOARD_ITEM::HasDrilledHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 161 of file board_item.h.

Referenced by DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::InspectClearance(), and PNS_PCBNEW_RULE_RESOLVER::IsDrilledHole().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 146 of file eda_item.h.

References m_flags.

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

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 156 of file board_item.h.

Referenced by DRAWING_TOOL::DrawVia(), DRC_RTREE::Insert(), BOARD_INSPECTION_TOOL::InspectClearance(), 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(), and PCB_CONTROL::UpdateMessagePanel().

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

Referenced by CONVERT_TOOL::CreatePolys().

◆ HitTest() [1/3]

virtual bool EDA_ITEM::HitTest	(	const SHAPE_LINE_CHAIN &	aPoly,
		bool	aContained ) const

inlinevirtualinherited

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 in FOOTPRINT, PAD, PCB_DIMENSION_BASE, PCB_GROUP, PCB_MARKER, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, SCH_BITMAP, SCH_BUS_ENTRY_BASE, SCH_FIELD, SCH_JUNCTION, SCH_LABEL_BASE, SCH_LINE, SCH_NO_CONNECT, SCH_SHAPE, SCH_SHEET, SCH_SYMBOL, SCH_TABLE, SCH_TEXT, SCH_TEXTBOX, and ZONE.

Definition at line 258 of file eda_item.h.

◆ HitTest() [2/3]

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

overridevirtual

Hit-test a rectangle against the barcode bounding area.

Parameters

aRect	rectangle to test.
aContained	if true, test whether barcode is fully contained in aRect; otherwise test intersection.
aAccuracy	optional tolerance to inflate the barcode bounding box before testing.

Reimplemented from EDA_ITEM.

Definition at line 403 of file pcb_barcode.cpp.

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

◆ HitTest() [3/3]

bool PCB_BARCODE::HitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy ) const

overridevirtual

Hit-test a point against the barcode (text and symbol area).

Parameters

aPosition	point to test in internal units.
aAccuracy	tolerance (in internal units) for the hit test.

Returns: true if the point hits the barcode or its text.

Reimplemented from EDA_ITEM.

Definition at line 390 of file pcb_barcode.cpp.

References ARC_LOW_DEF, SHAPE_POLY_SET::Collide(), ERROR_OUTSIDE, GetBoundingBox(), GetBoundingHull(), and UNDEFINED_LAYER.

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 102 of file view_item.h.

References m_isBOARD_ITEM.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_GRID_HELPER::BestSnapAnchor(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), EDA_ITEM::EDA_ITEM(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), PCB_BASE_FRAME::FocusOnItem(), PCB_PROPERTIES_PANEL::getPropertyFromEvent(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD::Move(), PCB_GRID_HELPER::nearestAnchor(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::SelectAll(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), 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 129 of file eda_item.h.

References BRIGHTENED, and m_flags.

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

Referenced by DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PNS::NODE::FindItemByParent(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), BOARD_INSPECTION_TOOL::getItemDescription(), hasExactNetclassFunc(), hasNetclassFunc(), inDiffPairFunc(), BOARD_INSPECTION_TOOL::InspectClearance(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), and DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 128 of file eda_item.h.

References ENTERED, and m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 211 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

Definition at line 41 of file board_item.cpp.

References PCB_ARC_T, PCB_BARCODE_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIM_RADIAL_T, PCB_DIMENSION_T, PCB_FIELD_T, PCB_FOOTPRINT_T, PCB_GENERATOR_T, PCB_GROUP_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TEXT_T, PCB_TEXTBOX_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, and EDA_ITEM::Type().

Referenced by PCB_GROUP_TOOL::Group(), and BOARD_COMMIT::Push().

◆ IsKnockout()

bool PCB_BARCODE::IsKnockout ( ) const

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 403 of file pcb_barcode.h.

References BOARD_ITEM::IsKnockout().

Referenced by AssembleBarcode(), and PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 104 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 123 of file eda_item.h.

References IS_CHANGED, and m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

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

Definition at line 151 of file board_item.h.

References GetLayer(), and IsCopperLayer().

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::CheckNetTies(), DRC_ENGINE::EvalRules(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), PCB_SHAPE::GetItemDescription(), BOARD_INSPECTION_TOOL::InspectClearance(), PCB_SHAPE::IsConnected(), isCopper(), PCB_SELECTION_TOOL::isExpandableGraphicShape(), 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 314 of file board_item.h.

References m_layer.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), CREEPAGE_GRAPH::AddNetElements(), FOOTPRINT::CheckClippedSilk(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), CN_VISITOR::checkZoneItemConnection(), existsOnLayerFunc(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), isEdge(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_COMMIT::Push(), BOARD::RemoveAllItemsOnLayer(), ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), PCB_EDIT_FRAME::SetActiveLayer(), 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 439 of file eda_item.h.

Referenced by Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References m_isRollover.

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

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 101 of file view_item.h.

References m_isSCH_ITEM.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 127 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 184 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsSideSpecific()

bool BOARD_ITEM::IsSideSpecific ( ) const

inherited

Definition at line 191 of file board_item.cpp.

References 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 173 of file board_item.h.

Referenced by BOARD_INSPECTION_TOOL::InspectClearance(), 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 192 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(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), 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 325 of file eda_item.h.

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

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

◆ IterateForward() [2/2]

template<class T>

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

inlinestaticinherited

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

Definition at line 345 of file eda_item.h.

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

◆ KeepSquare()

bool PCB_BARCODE::KeepSquare ( ) const

inline

Definition at line 350 of file pcb_barcode.h.

References DATA_MATRIX, m_kind, MICRO_QR_CODE, and QR_CODE.

Referenced by SetBarcodeHeight(), and SetBarcodeWidth().

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 208 of file board_item.cpp.

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

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 39 of file view_item.cpp.

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

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

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 401 of file eda_item.h.

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

◆ Mirror()

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

virtualinherited

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 in PCB_ARC, PCB_DIM_ALIGNED, PCB_DIM_ORTHOGONAL, PCB_DIMENSION_BASE, PCB_GENERATOR, PCB_GROUP, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, and ZONE.

Definition at line 387 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass().

◆ Move()

void PCB_BARCODE::Move ( const VECTOR2I & offset )

overridevirtual

Function Move.

Parameters

offset	: moving vector Translate the barcode and its text by the given offset.
offset	translation vector in internal units.

Reimplemented from BOARD_ITEM.

Definition at line 127 of file pcb_barcode.cpp.

References m_bbox, m_poly, m_pos, m_symbolPoly, m_text, and m_textPoly.

Referenced by SetPosition().

◆ Normalize()

virtual void BOARD_ITEM::Normalize ( )

inlinevirtualinherited

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

Reimplemented in PCB_SHAPE, and PCB_TABLE.

Definition at line 370 of file board_item.h.

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

◆ NormalizeForCompare()

virtual void BOARD_ITEM::NormalizeForCompare ( )

inlinevirtualinherited

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

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

Reimplemented in PCB_SHAPE.

Definition at line 377 of file board_item.h.

References Normalize().

◆ operator<()

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

Returns: - True if aItem is less than the item.

Definition at line 319 of file eda_item.cpp.

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

◆ operator==()

bool PCB_BARCODE::operator== ( const BOARD_ITEM & aItem ) const

overridevirtual

Equality comparison operator for board-level deduplication.

Parameters

aItem other item to compare against.

Returns: true if the other item is a PCB_BARCODE and has identical key properties.

Implements BOARD_ITEM.

Definition at line 683 of file pcb_barcode.cpp.

References BOARD_ITEM::BOARD_ITEM(), ClassOf(), GetPosition(), GetText(), GetTextSize(), m_height, m_kind, m_width, and PCB_BARCODE().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 174 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 428 of file eda_item.h.

◆ Replace() [2/2]

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

staticinherited

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

Parameters

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

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

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

◆ Rotate()

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

overridevirtual

Rotate the barcode around a given centre by the given angle.

The underlying polygon and text are rotated; the width/height are updated from the new bounding box.

Parameters

aRotCentre	rotation centre in internal units.
aAngle	rotation angle.

Reimplemented from BOARD_ITEM.

Definition at line 138 of file pcb_barcode.cpp.

References AssembleBarcode(), m_angle, m_pos, and RotatePoint().

Referenced by BOOST_AUTO_TEST_CASE(), SetOrientation(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ RunOnChildren()

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

inlinevirtualinherited

Invoke a function on all children.

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

Reimplemented in BOARD, FOOTPRINT, PCB_GROUP, and PCB_TABLE.

Definition at line 208 of file board_item.h.

References BOARD_ITEM().

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

◆ Serialize()

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

virtualinherited

Serializes this object to the given Any message.

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

Parameters

aContainer will be filled with a message describing this object

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

Definition at line 24 of file serializable.cpp.

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

◆ Set() [1/4]

template<typename T>

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

inlineinherited

Definition at line 105 of file inspectable.h.

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

◆ Set() [2/4]

template<typename T>

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

inlineinherited

Definition at line 60 of file inspectable.h.

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

◆ Set() [3/4]

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

inlineinherited

Definition at line 43 of file inspectable.h.

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

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

◆ Set() [4/4]

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

inlineinherited

Definition at line 76 of file inspectable.h.

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().

◆ SetBarcodeErrorCorrection()

void PCB_BARCODE::SetBarcodeErrorCorrection ( BARCODE_ECC_T aErrorCorrection )

Definition at line 566 of file pcb_barcode.cpp.

References AssembleBarcode(), and SetErrorCorrection().

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ SetBarcodeHeight()

void PCB_BARCODE::SetBarcodeHeight ( int aHeight )

Definition at line 584 of file pcb_barcode.cpp.

References AssembleBarcode(), KeepSquare(), m_height, and m_width.

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ SetBarcodeKind()

void PCB_BARCODE::SetBarcodeKind ( BARCODE_T aKind )

Definition at line 595 of file pcb_barcode.cpp.

References AssembleBarcode(), and SetKind().

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ SetBarcodeText()

void PCB_BARCODE::SetBarcodeText ( const wxString & aText )

inline

Definition at line 366 of file pcb_barcode.h.

References AssembleBarcode(), and SetText().

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ SetBarcodeWidth()

void PCB_BARCODE::SetBarcodeWidth ( int aWidth )

Definition at line 573 of file pcb_barcode.cpp.

References AssembleBarcode(), KeepSquare(), m_height, and m_width.

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 135 of file eda_item.h.

References BRIGHTENED, and SetFlags().

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

◆ SetErrorCorrection()

void PCB_BARCODE::SetErrorCorrection ( BARCODE_ECC_T aErrorCorrection )

Set the error correction level used for QR codes.

Parameters

aErrorCorrection error correction enum value.

Definition at line 543 of file pcb_barcode.cpp.

References H, m_errorCorrection, m_kind, MICRO_QR_CODE, and Q.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SetBarcodeErrorCorrection(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

References m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 166 of file view_item.h.

References m_forcedTransparency.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 210 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 361 of file board_item.cpp.

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

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

◆ SetHeight()

void PCB_BARCODE::SetHeight ( int aHeight )

inline

Definition at line 122 of file pcb_barcode.h.

References m_height.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetIsKnockout()

void PCB_BARCODE::SetIsKnockout ( bool aEnable )

inlineoverridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 404 of file pcb_barcode.h.

References AssembleBarcode(), and BOARD_ITEM::SetIsKnockout().

Referenced by BOOST_AUTO_TEST_CASE(), PCB_BARCODE_DESC::PCB_BARCODE_DESC(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetIsRollover()

void EDA_ITEM::SetIsRollover ( bool aIsRollover )

inlineinherited

Definition at line 132 of file eda_item.h.

References m_isRollover.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 176 of file eda_item.h.

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

◆ SetKind()

void PCB_BARCODE::SetKind ( BARCODE_T aKind )

Definition at line 554 of file pcb_barcode.cpp.

References H, m_errorCorrection, m_kind, MICRO_QR_CODE, and Q.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SetBarcodeKind(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetLayer()

void PCB_BARCODE::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtual

Set the drawing layer for the barcode and its text.

Parameters

aLayer target PCB layer id.

Reimplemented from BOARD_ITEM.

Definition at line 103 of file pcb_barcode.cpp.

References AssembleBarcode(), BOARD_ITEM::m_layer, and m_text.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DRAWING_TOOL::DrawBarcode(), Flip(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetLayerSet()

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

inlinevirtualinherited

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

Definition at line 260 of file board_item.h.

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

Referenced by 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 323 of file board_item.h.

References m_isLocked.

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

◆ SetMargin()

void PCB_BARCODE::SetMargin ( const VECTOR2I & aMargin )

inline

Definition at line 128 of file pcb_barcode.h.

References m_margin.

Referenced by DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetMarginX()

void PCB_BARCODE::SetMarginX ( int aX )

inline

Definition at line 389 of file pcb_barcode.h.

References AssembleBarcode(), m_margin, and pcbIUScale.

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ SetMarginY()

void PCB_BARCODE::SetMarginY ( int aY )

inline

Definition at line 396 of file pcb_barcode.h.

References AssembleBarcode(), m_margin, and pcbIUScale.

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 100 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().

◆ SetOrientation()

void PCB_BARCODE::SetOrientation ( double aDegrees )

inline

Definition at line 375 of file pcb_barcode.h.

References DEGREES_T, GetPosition(), m_angle, and Rotate().

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and NETINFO_ITEM.

Definition at line 113 of file eda_item.h.

References EDA_ITEM(), and m_parent.

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

◆ 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(), PCB_IO_KICAD_SEXPR::FootprintSave(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_SYMBOL::GetOrientation(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), EDA_GROUP::RemoveItem(), SaveCopyOfZones(), and CLIPBOARD_IO::SaveSelection().

◆ SetPosition()

void PCB_BARCODE::SetPosition ( const VECTOR2I & aPos )

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 72 of file pcb_barcode.cpp.

References delta, m_pos, and Move().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DRAWING_TOOL::DrawBarcode(), SetRect(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetRect()

void PCB_BARCODE::SetRect	(	const VECTOR2I &	aTopLeft,
		const VECTOR2I &	aBotRight )

Set the bounding rectangle of the barcode.

This will scale the internal polygon outlines to fit the given rectangle and update width/height accordingly. This refers to the size of the barcode symbol excluding margins and text.

Parameters

aTopLeft	top-left coordinate in internal units.
aBotRight	bottom-right coordinate in internal units.

Definition at line 420 of file pcb_barcode.cpp.

References delta, BOX2< Vec >::GetCenter(), BOX2< Vec >::GetHeight(), BOX2< Vec >::GetWidth(), m_height, m_symbolPoly, m_width, pcbIUScale, SetPosition(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by AssembleBarcode().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 134 of file eda_item.h.

References SELECTED, and SetFlags().

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

◆ SetShowText()

void PCB_BARCODE::SetShowText ( bool aShow )

inline

Definition at line 367 of file pcb_barcode.h.

References AssembleBarcode(), and m_text.

Referenced by PCB_BARCODE_DESC::PCB_BARCODE_DESC().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 127 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass().

◆ SetText()

void PCB_BARCODE::SetText ( const wxString & aText )

Set the barcode content text to encode.

Parameters

aText UTF-8 string content for the barcode.

Definition at line 85 of file pcb_barcode.cpp.

References m_text.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), SetBarcodeText(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetTextSize()

void PCB_BARCODE::SetTextSize ( int aTextSize )

Change the height of the human-readable text displayed below the barcode.

Parameters

aTextSize text size in internal units. Will be used for both x and y.

Definition at line 112 of file pcb_barcode.cpp.

References AssembleBarcode(), GetPenSizeForNormal(), and m_text.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DRAWING_TOOL::DrawBarcode(), PCB_BARCODE_DESC::PCB_BARCODE_DESC(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), StyleFromSettings(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetWidth()

void PCB_BARCODE::SetWidth ( int aWidth )

inline

Definition at line 116 of file pcb_barcode.h.

References m_width.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 117 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 123 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_BARCODE::Similarity ( const BOARD_ITEM & aItem ) const

overridevirtual

Compute a simple similarity score between this barcode and another board item.

Parameters

aItem other item to compare.

Returns: similarity value between 0.0 and 1.0.

Implements BOARD_ITEM.

Definition at line 624 of file pcb_barcode.cpp.

References BOARD_ITEM::BOARD_ITEM(), ClassOf(), GetPosition(), GetText(), GetTextSize(), m_height, m_kind, m_width, and PCB_BARCODE().

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

References EDA_ITEM().

◆ StyleFromSettings()

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

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 160 of file pcb_barcode.cpp.

References BOARD_ITEM::GetLayer(), BOARD_DESIGN_SETTINGS::GetTextSize(), and SetTextSize().

◆ swapData()

void PCB_BARCODE::swapData ( BOARD_ITEM * aImage )

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 611 of file pcb_barcode.cpp.

References BOARD_ITEM::BOARD_ITEM(), m_text, PCB_BARCODE(), PCB_BARCODE_T, EDA_ITEM::SetParent(), 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 271 of file board_item.cpp.

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

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

◆ Text() [1/2]

PCB_TEXT & PCB_BARCODE::Text ( )

inline

Access the internal PCB_TEXT object used for showing the human-readable text.

Definition at line 209 of file pcb_barcode.h.

References m_text.

Referenced by BOOST_AUTO_TEST_CASE(), hash_fp_item(), and DIALOG_BARCODE_PROPERTIES::transferDataToBarcode().

◆ Text() [2/2]

const PCB_TEXT & PCB_BARCODE::Text ( ) const

inline

Definition at line 210 of file pcb_barcode.h.

References m_text.

◆ TransformShapeToPolygon()

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

overridevirtual

Convert the barcode (text + symbol shapes) to polygonal geometry suitable for filling/collision tests.

The function appends geometry to aBuffer for the specified aLayer. When aClearance is non-zero the internal polygon is inflated by that amount before being merged.

Parameters

aBuffer	output buffer to receive polygon outlines.
aLayer	layer to convert (only geometry on this layer is added).
aClearance	clearance/inflation to apply around shapes (in internal units).
aMaxError	maximum error when approximating arcs.
aErrorLoc	whether approximation error should be placed outside or inside the polygon.
ignoreLineWidth	unused.

Reimplemented from BOARD_ITEM.

Definition at line 479 of file pcb_barcode.cpp.

References SHAPE_POLY_SET::Append(), CHAMFER_ACUTE_CORNERS, SHAPE_POLY_SET::Inflate(), BOARD_ITEM::m_layer, m_poly, and UNDEFINED_LAYER.

Referenced by BOARD::ConvertBrdLayerToPolygonalContours(), and GetEffectiveShape().

◆ TransformShapeToPolySet()

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

inlinevirtualinherited

Convert the item shape to a polyset.

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

Parameters

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

Reimplemented in PCB_SHAPE.

Definition at line 425 of file board_item.h.

References TransformShapeToPolygon().

Referenced by BOARD_ADAPTER::addBarCode(), EXPORTER_STEP::buildGraphic3DShape(), BOARD_ADAPTER::createLayers(), KIGFX::PCB_PAINTER::draw(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), PCB_TRACK::GetMsgPanelInfo(), CONVERT_TOOL::makePolysFromClosedGraphics(), BRDITEMS_PLOTTER::PlotBarCode(), and FOOTPRINT::TransformFPShapesToPolySet().

◆ 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 PCB_BARCODE::ViewBBox ( ) const

overridevirtual

Get the bbox used for drawing/view culling, may include additional view-only extents.

Reimplemented from EDA_ITEM.

Definition at line 473 of file pcb_barcode.cpp.

References m_bbox.

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

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

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

Definition at line 127 of file view_item.h.

References VIEW.

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

◆ ViewGetLayers()

std::vector< int > 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_GROUP, PCB_MARKER, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_TUNING_PATTERN, PCB_VIA, and ZONE.

Definition at line 244 of file board_item.cpp.

References IsLocked(), LAYER_LOCKED_ITEM_SHADOW, and m_layer.

◆ ViewGetLOD()

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

inlinevirtualinherited

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

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

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

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

Parameters

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 in FOOTPRINT, GERBER_DRAW_ITEM, PAD, PCB_FIELD, PCB_GROUP, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, SCH_GROUP, SCH_LINE, and ZONE.

Definition at line 155 of file view_item.h.

References LOD_SHOW, and VIEW.

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

◆ viewPrivData()

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

inlineinherited

◆ Visit()

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

virtualinherited

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

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

Parameters

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 in BOARD, FOOTPRINT, GBR_LAYOUT, GERBER_DRAW_ITEM, GERBER_FILE_IMAGE, LIB_SYMBOL, PCB_GROUP, PCB_TABLE, PCB_TRACK, SCH_GROUP, SCH_LABEL_BASE, SCH_SHEET, SCH_SYMBOL, and SCH_TABLE.

Definition at line 127 of file eda_item.cpp.

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

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

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 143 of file eda_item.h.

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

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 180 of file view_item.h.

Referenced by lodScaleForThreshold(), KIGFX::VIEW_GROUP::ViewDraw(), FOOTPRINT::ViewGetLOD(), PAD::ViewGetLOD(), PCB_FIELD::ViewGetLOD(), PCB_GROUP::ViewGetLOD(), PCB_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::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 185 of file view_item.h.

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

◆ m_angle

EDA_ANGLE PCB_BARCODE::m_angle

private

Definition at line 417 of file pcb_barcode.h.

Referenced by AssembleBarcode(), Flip(), GetAngle(), GetBoundingHull(), GetMsgPanelInfo(), GetOrientation(), PCB_BARCODE(), Rotate(), and SetOrientation().

◆ m_bbox

BOX2I PCB_BARCODE::m_bbox

private

BBox of m_poly (ie: barcode + text)

Definition at line 423 of file pcb_barcode.h.

Referenced by AssembleBarcode(), GetBoundingBox(), Move(), and ViewBBox().

◆ m_errorCorrection

BARCODE_ECC_T PCB_BARCODE::m_errorCorrection

private

Error correction level for QR codes.

Definition at line 418 of file pcb_barcode.h.

Referenced by ComputeBarcode(), GetErrorCorrection(), PCB_BARCODE(), SetErrorCorrection(), and SetKind().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 527 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 210 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 530 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), ZONE::InitDataFromSrcInCopyCtor(), IsForceVisible(), operator=(), PCB_SHAPE::operator==(), SetForceVisible(), 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 529 of file eda_item.h.

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

◆ m_height

int PCB_BARCODE::m_height

private

Barcode height.

Definition at line 412 of file pcb_barcode.h.

Referenced by AssembleBarcode(), GetHeight(), operator==(), PCB_BARCODE(), SetBarcodeHeight(), SetBarcodeWidth(), SetHeight(), SetRect(), and Similarity().

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 208 of file view_item.h.

Referenced by IsBOARD_ITEM(), and VIEW_ITEM().

◆ m_isKnockout

bool BOARD_ITEM::m_isKnockout

protectedinherited

Definition at line 454 of file board_item.h.

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

◆ m_isLocked

bool BOARD_ITEM::m_isLocked

protectedinherited

Definition at line 456 of file board_item.h.

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

◆ m_isRollover

bool EDA_ITEM::m_isRollover

protectedinherited

Definition at line 531 of file eda_item.h.

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

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 207 of file view_item.h.

Referenced by IsSCH_ITEM(), and VIEW_ITEM().

◆ m_kind

BARCODE_T PCB_BARCODE::m_kind

private

Definition at line 416 of file pcb_barcode.h.

Referenced by ComputeBarcode(), GetKind(), GetMsgPanelInfo(), KeepSquare(), operator==(), PCB_BARCODE(), SetErrorCorrection(), SetKind(), and Similarity().

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 453 of file board_item.h.

Referenced by PCB_BARCODE::AssembleBarcode(), BOARD_ITEM(), FOOTPRINT::FOOTPRINT(), PCB_BARCODE::GetBoundingHull(), PCB_VIA::GetDrillConstraint(), GetLayer(), PCB_SHAPE::GetLayer(), GetLayerName(), GetLayerSet(), PCB_SHAPE::GetLayerSet(), PCB_TRACK::GetLayerSet(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PCB_TUNING_PATTERN::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(), 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_TUNING_PATTERN::recoverBaseline(), PCB_MARKER::SerializeToString(), SetLayer(), PCB_BARCODE::SetLayer(), PCB_GENERATOR::SetLayer(), PCB_ARC::Similarity(), PCB_REFERENCE_IMAGE::Similarity(), PCB_TRACK::Similarity(), PCB_VIA::Similarity(), PCB_DIMENSION_BASE::StyleFromSettings(), 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_POINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), and PCB_TRACK::ViewGetLOD().

◆ m_margin

VECTOR2I PCB_BARCODE::m_margin

private

Margin around the barcode (only valid for knockout)

Definition at line 414 of file pcb_barcode.h.

Referenced by AssembleBarcode(), GetMargin(), GetMarginX(), GetMarginY(), SetMargin(), SetMarginX(), and SetMarginY().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Owner.

Definition at line 528 of file eda_item.h.

Referenced by PCB_BOARD_OUTLINE::CopyPros(), SCH_FIELD::DoHypertextAction(), EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), SCH_FIELD::GetBoundingBox(), SCH_FIELD::GetCanonicalName(), 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_FIELD::GetShownText(), SCH_TEXT::GetShownText(), SCH_FIELD::getUnescapedText(), SCH_FIELD::HitTest(), SCH_PIN::IsStacked(), SCH_FIELD::Matches(), BOARD_BOUNDING_BOX::operator=(), operator=(), PAD::operator==(), PCB_BOARD_OUTLINE::operator==(), PAD::PAD(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_FIELD::Replace(), SCH_LABEL_BASE::ResolveTextVar(), SCH_FIELD::SCH_FIELD(), SCH_SYMBOL::SCH_SYMBOL(), SetModified(), SetParent(), SCH_FIELD::SetPosition(), PAD::Similarity(), PCB_BOARD_OUTLINE::Similarity(), PCB_REFERENCE_IMAGE::swapData(), and PCB_SHAPE::swapData().

◆ m_poly

SHAPE_POLY_SET PCB_BARCODE::m_poly

private

Full geometry (barcode + optional text or knockout)

Definition at line 420 of file pcb_barcode.h.

Referenced by AssembleBarcode(), GetPolyShape(), Move(), and TransformShapeToPolygon().

◆ m_pos

VECTOR2I PCB_BARCODE::m_pos

private

Position of the barcode.

Definition at line 413 of file pcb_barcode.h.

Referenced by AssembleBarcode(), Flip(), GetBoundingHull(), GetPosition(), Move(), PCB_BARCODE(), Rotate(), and SetPosition().

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

See comment near SetType() regarding virtual functions.

Definition at line 524 of file eda_item.h.

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

◆ m_symbolPoly

SHAPE_POLY_SET PCB_BARCODE::m_symbolPoly

private

Barcode symbol only (cached, centered at origin)

Definition at line 421 of file pcb_barcode.h.

Referenced by AssembleBarcode(), ComputeBarcode(), ComputeTextPoly(), GetBoundingHull(), GetSymbolPoly(), Move(), and SetRect().

◆ m_text

PCB_TEXT PCB_BARCODE::m_text

private

Definition at line 415 of file pcb_barcode.h.

Referenced by AssembleBarcode(), Clone(), ComputeTextPoly(), GetMsgPanelInfo(), GetShownText(), GetShowText(), GetText(), GetTextSize(), Move(), PCB_BARCODE(), SetLayer(), SetShowText(), SetText(), SetTextSize(), swapData(), Text(), and Text().

◆ m_textPoly

SHAPE_POLY_SET PCB_BARCODE::m_textPoly

private

Human-readable text only (cached, centered/positioned)

Definition at line 422 of file pcb_barcode.h.

Referenced by AssembleBarcode(), ComputeTextPoly(), GetBoundingHull(), GetTextPoly(), and Move().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 516 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 209 of file view_item.h.

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

◆ m_width

int PCB_BARCODE::m_width

private

Barcode width.

Definition at line 411 of file pcb_barcode.h.

Referenced by AssembleBarcode(), GetWidth(), operator==(), PCB_BARCODE(), SetBarcodeHeight(), SetBarcodeWidth(), SetRect(), SetWidth(), and Similarity().

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

Definition at line 181 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 Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

Constructor & Destructor Documentation

◆ PCB_BARCODE()

◆ ~PCB_BARCODE()

Member Function Documentation

◆ AssembleBarcode()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Compare()

◆ ComputeBarcode()

◆ ComputeTextPoly()

◆ CopyFrom()

◆ DeleteStructure()

◆ Deserialize()

◆ Duplicate()

◆ findParent()

◆ Flip()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAngle()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoundingBox()

◆ GetBoundingHull()

◆ GetCenter()

◆ GetClass()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveShape()

◆ GetEmbeddedFiles()

◆ GetEmbeddedFonts()

◆ GetErrorCorrection()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFontMetrics()

◆ GetForcedTransparency()

◆ GetFPRelativePosition()

◆ GetFriendlyName()

◆ GetHeight()

◆ GetItemDescription()

◆ GetKind()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetMargin()

◆ GetMarginX()

◆ GetMarginY()

◆ GetMaxError()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetOrientation()

◆ GetParent()

◆ GetParentAsString()

◆ GetParentFootprint()

◆ GetParentGroup()

◆ GetParentGroupId()

◆ GetPolyShape()

◆ GetPosition()

◆ GetShownText()