Inheritance diagram for PCB_TUNING_PATTERN:

Public Member Functions
	PCB_TUNING_PATTERN (BOARD_ITEM *aParent=nullptr, PCB_LAYER_ID aLayer=F_Cu, LENGTH_TUNING_MODE aMode=LENGTH_TUNING_MODE::SINGLE)

wxString	GetGeneratorType () const override

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

wxString	GetFriendlyName () const override

wxString	GetPluralName () const override

void	EditStart (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit) override

bool	Update (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit) override

void	EditPush (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit, const wxString &aCommitMsg=wxEmptyString, int aCommitFlags=0) override

void	EditRevert (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit) override

void	Remove (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit) override

bool	MakeEditPoints (std::shared_ptr< EDIT_POINTS > points) const override

bool	UpdateFromEditPoints (std::shared_ptr< EDIT_POINTS > aEditPoints, BOARD_COMMIT *aCommit) override

bool	UpdateEditPoints (std::shared_ptr< EDIT_POINTS > aEditPoints) override

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

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

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

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

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

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

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

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

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

const VECTOR2I &	GetEnd () const

void	SetEnd (const VECTOR2I &aValue)

int	GetEndX () const

void	SetEndX (int aValue)

int	GetEndY () const

void	SetEndY (int aValue)

LENGTH_TUNING_MODE	GetTuningMode () const

PNS::ROUTER_MODE	GetPNSMode ()

PNS::MEANDER_SETTINGS &	GetSettings ()

int	GetMinAmplitude () const

void	SetMinAmplitude (int aValue)

int	GetMaxAmplitude () const

void	SetMaxAmplitude (int aValue)

PNS::MEANDER_SIDE	GetInitialSide () const

void	SetInitialSide (PNS::MEANDER_SIDE aValue)

int	GetSpacing () const

void	SetSpacing (int aValue)

std::optional< int >	GetTargetLength () const

void	SetTargetLength (std::optional< int > aValue)

int	GetTargetSkew () const

void	SetTargetSkew (int aValue)

bool	GetOverrideCustomRules () const

void	SetOverrideCustomRules (bool aOverride)

int	GetCornerRadiusPercentage () const

void	SetCornerRadiusPercentage (int aValue)

bool	IsSingleSided () const

void	SetSingleSided (bool aValue)

bool	IsRounded () const

void	SetRounded (bool aFlag)

std::vector< std::pair< wxString, wxVariant > >	GetRowData () override

const STRING_ANY_MAP	GetProperties () const override

void	SetProperties (const STRING_ANY_MAP &aProps) override

void	ShowPropertiesDialog (PCB_BASE_EDIT_FRAME *aEditFrame) override

std::vector< EDA_ITEM * >	GetPreviewItems (GENERATOR_TOOL aTool, PCB_BASE_EDIT_FRAME aFrame, bool aStatusItemsOnly=false) override

void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.

PCB_GENERATOR *	DeepClone () const

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPos) override

bool	AddItem (BOARD_ITEM *aItem) override
	Add item to group.

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

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

wxString	GetClass () const override
	Return the class name.

wxString	GetName () const

void	SetName (const wxString &aName)

std::unordered_set< BOARD_ITEM * > &	GetItems ()

const std::unordered_set< BOARD_ITEM * > &	GetItems () const

virtual bool	RemoveItem (BOARD_ITEM *aItem)
	Remove item from group.

void	RemoveAll ()

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

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

bool	IsOnCopperLayer () const override

void	SetLocked (bool aLocked) override

PCB_GROUP *	DeepDuplicate () const

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

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.

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

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

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

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

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

void	RunOnDescendants (const std::function< void(BOARD_ITEM *)> &aFunction, int aDepth=0) const override
	Invoke a function on all descendants.

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

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

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

virtual bool	IsTented () const

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

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 void	SetLayerSet (LSET aLayers)

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

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

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

virtual bool	IsLocked () const

virtual void	StyleFromSettings (const BOARD_DESIGN_SETTINGS &settings)

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

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

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

virtual BOARD *	GetBoard ()

wxString	GetParentAsString () const
	For "parent" property.

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

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

KICAD_T	Type () const
	Returns the type of object.

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

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 const VECTOR2I	GetFocusPosition () const
	Similar to GetPosition, but allows items to return their visual center rather than their anchor.

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

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

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

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 PCB_TUNING_PATTERN *	CreateNew (GENERATOR_TOOL aTool, PCB_BASE_EDIT_FRAME aFrame, BOARD_CONNECTED_ITEM *aStartItem, LENGTH_TUNING_MODE aMode)

static bool	ClassOf (const EDA_ITEM *aItem)

static PCB_GROUP *	TopLevelGroup (BOARD_ITEM aItem, PCB_GROUP aScope, bool isFootprintEditor)

static bool	WithinScope (BOARD_ITEM aItem, PCB_GROUP aScope, bool isFootprintEditor)

static bool	IsGroupableType (KICAD_T aType)
	Check if the proposed type can be added to a group.

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 const wxString	GENERATOR_TYPE = wxS( "tuning_pattern" )

static const wxString	DISPLAY_NAME = _HKI( "Tuning Pattern" )

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

Protected Member Functions
void	swapData (BOARD_ITEM *aImage) override

bool	recoverBaseline (PNS::ROUTER *aRouter)

bool	baselineValid ()

bool	initBaseLine (PNS::ROUTER aRouter, int aLayer, BOARD aBoard, VECTOR2I &aStart, VECTOR2I &aEnd, NETINFO_ITEM *aNet, std::optional< SHAPE_LINE_CHAIN > &aBaseLine)

bool	initBaseLines (PNS::ROUTER aRouter, int aLayer, BOARD aBoard)

bool	removeToBaseline (PNS::ROUTER *aRouter, int aLayer, SHAPE_LINE_CHAIN &aBaseLine)

bool	resetToBaseline (GENERATOR_TOOL *aTool, int aLayer, SHAPE_LINE_CHAIN &aBaseLine, bool aPrimary)

SHAPE_LINE_CHAIN	getOutline () const

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.

Protected Attributes
VECTOR2I	m_end

PNS::MEANDER_SETTINGS	m_settings

std::optional< SHAPE_LINE_CHAIN >	m_baseLine

std::optional< SHAPE_LINE_CHAIN >	m_baseLineCoupled

int	m_trackWidth

int	m_diffPairGap

LENGTH_TUNING_MODE	m_tuningMode

wxString	m_lastNetName

wxString	m_tuningInfo

PNS::MEANDER_PLACER_BASE::TUNING_STATUS	m_tuningStatus

wxString	m_generatorType

VECTOR2I	m_origin

std::unordered_set< BOARD_ITEM * >	m_items

wxString	m_name

PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

PCB_GROUP *	m_group

EDA_ITEM *	m_parent
	Linked list: Link (parent struct)

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

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

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items.

Detailed Description

Definition at line 242 of file pcb_tuning_pattern.cpp.

Constructor & Destructor Documentation

◆ PCB_TUNING_PATTERN()

PCB_TUNING_PATTERN::PCB_TUNING_PATTERN	(	BOARD_ITEM *	aParent = `nullptr`,
		PCB_LAYER_ID	aLayer = `F_Cu`,
		LENGTH_TUNING_MODE	aMode = `LENGTH_TUNING_MODE::SINGLE`
	)

Definition at line 602 of file pcb_tuning_pattern.cpp.

References DISPLAY_NAME, GENERATOR_TYPE, m_end, PCB_GENERATOR::m_generatorType, PNS::MEANDER_SETTINGS::m_initialSide, PCB_GROUP::m_name, m_settings, PNS::MEANDER_SIDE_LEFT, EDA_IU_SCALE::mmToIU(), and pcbIUScale.

Member Function Documentation

◆ AddItem()

bool PCB_GENERATOR::AddItem ( BOARD_ITEM * aItem )

overridevirtualinherited

Add item to group.

Does not take ownership of item.

Returns: true if item was added (false if item belongs to a different group).

Reimplemented from PCB_GROUP.

Definition at line 130 of file pcb_generator.cpp.

References BOARD_ITEM::GetParentGroup(), PCB_GROUP::m_items, PCB_GROUP::RemoveItem(), and BOARD_ITEM::SetParentGroup().

Referenced by PCB_GENERATOR::DeepClone(), and EditPush().

◆ baselineValid()

bool PCB_TUNING_PATTERN::baselineValid ( )

protected

Definition at line 660 of file pcb_tuning_pattern.cpp.

References DIFF_PAIR, DIFF_PAIR_SKEW, m_baseLine, m_baseLineCoupled, and m_tuningMode.

Referenced by EditStart(), recoverBaseline(), Remove(), and Update().

◆ ClassOf()

bool PCB_GENERATOR::ClassOf ( const EDA_ITEM * aItem )

inlinestaticinherited

Definition at line 206 of file pcb_generator.cpp.

References PCB_GENERATOR_T, and EDA_ITEM::Type().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 122 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

Referenced by FOOTPRINT_DIFF_WIDGET::DisplayDiff(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), PL_SELECTION_TOOL::unhighlight(), EE_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 140 of file eda_item.h.

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

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 128 of file eda_item.h.

References EDA_ITEM::m_flags.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 121 of file eda_item.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), FOOTPRINT_DIFF_WIDGET::DisplayDiff(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), SCH_COMMIT::Revert(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_COMMIT::Stage(), PL_SELECTION_TOOL::unhighlight(), EE_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 152 of file eda_item.h.

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

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

◆ Clone()

EDA_ITEM * PCB_TUNING_PATTERN::Clone ( ) const

inlineoverridevirtual

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

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 355 of file pcb_tuning_pattern.cpp.

Referenced by DRAWING_TOOL::PlaceTuningPattern().

◆ CreateNew()

PCB_TUNING_PATTERN * PCB_TUNING_PATTERN::CreateNew	(	GENERATOR_TOOL *	aTool,
		PCB_BASE_EDIT_FRAME *	aFrame,
		BOARD_CONNECTED_ITEM *	aStartItem,
		LENGTH_TUNING_MODE	aMode
	)

static

◆ DeepClone()

PCB_GENERATOR * PCB_GENERATOR::DeepClone ( ) const

inherited

Definition at line 39 of file pcb_generator.cpp.

References PCB_GENERATOR::AddItem(), PCB_GROUP::Clone(), PCB_GROUP::DeepClone(), PCB_GROUP::m_items, and PCB_GROUP_T.

◆ DeepDuplicate()

PCB_GROUP * PCB_GROUP::DeepDuplicate ( ) const

inherited

Definition at line 221 of file pcb_group.cpp.

References PCB_GROUP::AddItem(), PCB_GROUP::DeepDuplicate(), BOARD_ITEM::Duplicate(), PCB_GROUP::m_items, and PCB_GROUP_T.

Referenced by PCB_GROUP::DeepDuplicate().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 159 of file board_item.cpp.

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

◆ Deserialize()

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

inlinevirtualinherited

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 SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, BOARD_STACKUP, FOOTPRINT, PAD, PCB_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TRACK, PCB_ARC, and PCB_VIA.

Definition at line 53 of file serializable.h.

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 193 of file board_item.cpp.

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

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

◆ EditPush()

void PCB_TUNING_PATTERN::EditPush	(	GENERATOR_TOOL *	aTool,
		BOARD *	aBoard,
		BOARD_COMMIT *	aCommit,
		const wxString &	aCommitMsg = `wxEmptyString`,
		int	aCommitFlags = `0`
	)

overridevirtual

◆ EditRevert()

void PCB_TUNING_PATTERN::EditRevert	(	GENERATOR_TOOL *	aTool,
		BOARD *	aBoard,
		BOARD_COMMIT *	aCommit
	)

overridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 1463 of file pcb_tuning_pattern.cpp.

References EDA_ITEM::ClearFlags(), PNS_KICAD_IFACE::EraseView(), EDA_ITEM::GetFlags(), PNS::TOOL_BASE::GetInterface(), TOOL_BASE::GetManager(), GENERATOR_TOOL_PNS_PROXY::GetRouterChanges(), TOOL_MANAGER::GetView(), IN_EDIT, BOARD_COMMIT::Revert(), PNS::TOOL_BASE::Router(), and PNS::ROUTER::StopRouting().

Referenced by DRAWING_TOOL::PlaceTuningPattern().

◆ EditStart()

void PCB_TUNING_PATTERN::EditStart	(	GENERATOR_TOOL *	aTool,
		BOARD *	aBoard,
		BOARD_COMMIT *	aCommit
	)

overridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 708 of file pcb_tuning_pattern.cpp.

References COMMIT::Add(), baselineValid(), GENERATOR_TOOL_PNS_PROXY::ClearRouterChanges(), PNS::CT_DIFF_PAIR_SKEW, PNS::CT_LENGTH, DIFF_PAIR, BOARD::DpCoupledNet(), BOARD_ITEM::GetLayer(), TOOL_BASE::GetManager(), BOARD_CONNECTED_ITEM::GetNet(), PNS::ROUTER::GetRuleResolver(), IN_EDIT, initBaseLines(), EDA_ITEM::IsNew(), PCB_GENERATOR::m_origin, PNS::MEANDER_SETTINGS::m_overrideCustomRules, m_settings, PNS::MEANDER_SETTINGS::m_targetSkew, m_tuningMode, PNS::CONSTRAINT::m_Value, COMMIT::Modify(), TOOL_MANAGER::PostEvent(), resolver, PNS::TOOL_BASE::Router(), EVENTS::SelectedItemsModified, EDA_ITEM::SetFlags(), PNS::ITEM::SetNet(), PNS::ITEM::SetParent(), PNS::MEANDER_SETTINGS::SetTargetLength(), SINGLE, snapToNearestTrack(), and PNS::ROUTER::SyncWorld().

Referenced by DRAWING_TOOL::PlaceTuningPattern(), and ShowPropertiesDialog().

◆ Flip()

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

overridevirtualinherited

Flip this object, i.e.

change the board side for this object.

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 359 of file pcb_group.cpp.

References PCB_GROUP::m_items.

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 119 of file inspectable.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 99 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 107 of file inspectable.h.

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

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 60 of file board_item.cpp.

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

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 46 of file board_item.cpp.

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

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

◆ GetBoundingBox()

const BOX2I PCB_TUNING_PATTERN::GetBoundingBox ( ) const

inlineoverridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 323 of file pcb_tuning_pattern.cpp.

References SHAPE_LINE_CHAIN::BBox(), and getOutline().

Referenced by HitTest(), and ViewBBox().

◆ GetCenter()

virtual VECTOR2I BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

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

Returns: center point of the item

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

Definition at line 112 of file board_item.h.

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

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

◆ GetClass()

wxString PCB_GENERATOR::GetClass ( ) const

overridevirtualinherited

Return the class name.

Implements EDA_ITEM.

Definition at line 200 of file pcb_generator.cpp.

◆ GetCornerRadiusPercentage()

int PCB_TUNING_PATTERN::GetCornerRadiusPercentage ( ) const

inline

Definition at line 433 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_cornerRadiusPercentage, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 132 of file eda_item.h.

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

◆ GetEffectiveHoleShape()

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

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 238 of file board_item.cpp.

References EDA_ITEM::GetClass(), and UNIMPLEMENTED_FOR.

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

overridevirtualinherited

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

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

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 278 of file pcb_group.cpp.

References PCB_GROUP::m_items.

◆ GetEnd()

const VECTOR2I & PCB_TUNING_PATTERN::GetEnd ( ) const

inline

Definition at line 359 of file pcb_tuning_pattern.cpp.

References m_end.

Referenced by DRAWING_TOOL::PlaceTuningPattern().

◆ GetEndX()

int PCB_TUNING_PATTERN::GetEndX ( ) const

inline

Definition at line 362 of file pcb_tuning_pattern.cpp.

References m_end, and VECTOR2< T >::x.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetEndY()

int PCB_TUNING_PATTERN::GetEndY ( ) const

inline

Definition at line 365 of file pcb_tuning_pattern.cpp.

References m_end, and VECTOR2< T >::y.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 129 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), SCH_TABLE::DeleteMarkedCells(), PCB_TABLE::DeleteMarkedCells(), doConvertOutlineToPolygon(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), EditPush(), EditRevert(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), EE_SELECTION_TOOL::Main(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and 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_SHAPE, PCB_TRACK, and PCB_ARC.

Definition at line 249 of file eda_item.h.

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), and DRAWING_TOOL::PlaceTuningPattern().

◆ GetFontMetrics()

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

inherited

Definition at line 97 of file board_item.cpp.

References KIFONT::METRICS::Default().

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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 157 of file view_item.h.

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

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 262 of file board_item.cpp.

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

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

◆ GetFriendlyName()

wxString PCB_TUNING_PATTERN::GetFriendlyName ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 258 of file pcb_tuning_pattern.cpp.

References _.

Referenced by GetMsgPanelInfo().

◆ GetGeneratorType()

wxString PCB_TUNING_PATTERN::GetGeneratorType ( ) const

inlineoverridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 251 of file pcb_tuning_pattern.cpp.

◆ GetInitialSide()

PNS::MEANDER_SIDE PCB_TUNING_PATTERN::GetInitialSide ( ) const

inline

Definition at line 405 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_initialSide, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetItemDescription()

wxString PCB_TUNING_PATTERN::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) const

inlineoverridevirtual

Return a user-visible description string of this item.

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

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 253 of file pcb_tuning_pattern.cpp.

References _.

◆ GetItems() [1/2]

std::unordered_set< BOARD_ITEM * > & PCB_GROUP::GetItems ( )

inlineinherited

Definition at line 68 of file pcb_group.h.

References PCB_GROUP::m_items.

Referenced by EDIT_TOOL::DeleteItems(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), PCB_SELECTION_TOOL::expandConnection(), FOOTPRINT::FOOTPRINT(), PCB_IO_KICAD_SEXPR::format(), FOOTPRINT::GetCoverageArea(), GetMsgPanelInfo(), BOARD_INSPECTION_TOOL::InspectClearance(), FOOTPRINT::operator=(), DRAWING_TOOL::PlaceTuningPattern(), Remove(), and testGroupEqual().

◆ GetItems() [2/2]

const std::unordered_set< BOARD_ITEM * > & PCB_GROUP::GetItems ( ) const

inlineinherited

Definition at line 73 of file pcb_group.h.

References PCB_GROUP::m_items.

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in FOOTPRINT, PAD, PCB_SHAPE, and ZONE.

Definition at line 226 of file board_item.h.

References BOARD_ITEM::m_layer.

Referenced by CN_CONNECTIVITY_ALGO::Add(), BOARD::Add(), CN_LIST::Add(), PCB_TABLE::AddCell(), BOARD_ADAPTER::addFootprintShapes(), STEP_PCB_MODEL::AddTrackSegment(), TEARDROP_MANAGER::areItemsInSameZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), EXPORTER_STEP::buildTrack3DShape(), PNS::ITEM::collideSimple(), TEARDROP_MANAGER::computeTeardropPolygon(), CreateNew(), PCB_BASE_FRAME::CreateNewFootprint(), TEARDROP_MANAGER::createTeardrop(), BOARD_ADAPTER::createTrack(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_REFERENCE_IMAGE_PROPERTIES::DIALOG_REFERENCE_IMAGE_PROPERTIES(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawTable(), EditStart(), extractDiffPairCoupledItems(), EDIT_TOOL::FilletTracks(), TEARDROP_MANAGER::findAnchorPointsOnTrack(), TEARDROP_MANAGER::findTouchingTrack(), PCB_DIMENSION_BASE::Flip(), PCB_TABLE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), PCB_IO_KICAD_SEXPR::format(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetLayer(), PAD::GetLayer(), PCB_GENERATOR::GetLayerSet(), getMatchingTextItem(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), BOARD::GetPad(), FP_TEXT_GRID_TABLE::GetValueAsLong(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), PCB_TABLE::InsertCell(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), BOARD_ITEM::IsOnCopperLayer(), itemIsIncludedByFilter(), FABMASTER::loadFootprints(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), BOARD::cmp_items::operator()(), BOARD::cmp_drawings::operator()(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), PCB_TRACK::cmp_tracks::operator()(), PCB_REFERENCE_IMAGE_DESC::PCB_REFERENCE_IMAGE_DESC(), PCB_TABLECELL::PCB_TABLECELL(), DRAWING_TOOL::PlaceImportedGraphics(), DRAWING_TOOL::PlaceTuningPattern(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), BRDITEMS_PLOTTER::PlotPcbTarget(), DRC_ENGINE::ProcessAssertions(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), processTextItem(), PCB_CONTROL::pruneItemLayers(), Remove(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), DRC_TEST_PROVIDER_TEXT_DIMS::Run(), PCB_SELECTION_TOOL::Selectable(), PCB_TEXT::Serialize(), PCB_TRACK::Serialize(), PCB_ARC::Serialize(), FP_TEXT_GRID_TABLE::SetValueAsLong(), ShowPropertiesDialog(), PCB_TARGET::Similarity(), PCB_TEXT::StyleFromSettings(), EDIT_TOOL::Swap(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTextItem(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::SyncWorld(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), DRC_TEST_PROVIDER_MISC::testTextVars(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), TRACK_VIA_DESC::TRACK_VIA_DESC(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEARDROPS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), DIALOG_REFERENCE_IMAGE_PROPERTIES::TransferDataToWindow(), Update(), PCB_CONTROL::UpdateMessagePanel(), ViewGetLayers(), PCB_TEXT::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), PCB_TEXT::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

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

Returns: the layer name associated with this item.

Definition at line 103 of file board_item.cpp.

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

◆ GetLayerSet()

LSET PCB_GENERATOR::GetLayerSet ( ) const

overridevirtualinherited

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

Reimplemented from BOARD_ITEM.

Definition at line 142 of file pcb_generator.cpp.

References BOARD_ITEM::GetLayer(), and PCB_GROUP::GetLayerSet().

◆ GetMaxAmplitude()

int PCB_TUNING_PATTERN::GetMaxAmplitude ( ) const

inline

Definition at line 394 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_maxAmplitude, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetMenuImage()

BITMAPS PCB_GROUP::GetMenuImage ( ) const

overridevirtualinherited

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

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

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 375 of file pcb_group.cpp.

◆ GetMinAmplitude()

int PCB_TUNING_PATTERN::GetMinAmplitude ( ) const

inline

Definition at line 383 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_minAmplitude, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetMsgPanelInfo()

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

overridevirtual

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

Parameters

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

Reimplemented from EDA_ITEM.

Definition at line 1993 of file pcb_tuning_pattern.cpp.

References _, DIFF_PAIR_SKEW, BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), GetFriendlyName(), PCB_GROUP::GetItems(), NETCLASS::GetName(), DRC_CONSTRAINT::GetName(), BOARD_CONNECTED_ITEM::GetNetCode(), NETINFO_ITEM::GetNetname(), BOARD::GetTrackLength(), DRC_CONSTRAINT::GetValue(), DRC_CONSTRAINT::IsNull(), BOARD_ITEM::layerMaskDescribe(), LENGTH_CONSTRAINT, BOARD_DESIGN_SETTINGS::m_DRCEngine, BOARD_ITEM::m_layer, PNS::MEANDER_SETTINGS::m_overrideCustomRules, m_settings, PNS::MEANDER_SETTINGS::m_targetLength, PNS::MEANDER_SETTINGS::m_targetSkew, m_tuningMode, UNITS_PROVIDER::MessageTextFromMinOptMax(), UNITS_PROVIDER::MessageTextFromValue(), MINOPTMAX< T >::Opt(), SKEW_CONSTRAINT, and UnescapeString().

◆ GetName()

wxString PCB_GROUP::GetName ( ) const

inlineinherited

Definition at line 65 of file pcb_group.h.

References PCB_GROUP::m_name.

Referenced by createBoard(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_GROUP_DESC::PCB_GROUP_DESC(), and testGroupEqual().

◆ getOutline()

SHAPE_LINE_CHAIN PCB_TUNING_PATTERN::getOutline ( ) const

protected

◆ GetOverrideCustomRules()

bool PCB_TUNING_PATTERN::GetOverrideCustomRules ( ) const

inline

Definition at line 430 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_overrideCustomRules, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( ) const

inlineinherited

Definition at line 204 of file board_item.h.

References EDA_ITEM::m_parent.

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

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

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ GetParentFootprint()

FOOTPRINT * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 248 of file board_item.cpp.

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

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

◆ GetParentGroup()

PCB_GROUP * BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 91 of file board_item.h.

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), PCB_GENERATOR::AddItem(), EDIT_TOOL::DeleteItems(), BOARD_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), GENERATOR_TOOL::GENERATOR_TOOL(), getClosestGroup(), BOARD_ITEM::IsLocked(), memberOfGroupFunc(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), PCB_CONTROL::placeBoardItems(), DRAWING_TOOL::PlaceTuningPattern(), PCB_CONTROL::pruneItemLayers(), BOARD_COMMIT::Push(), BOARD::Remove(), FOOTPRINT::Remove(), GROUP_TOOL::RemoveFromGroup(), BOARD_COMMIT::Revert(), PCB_SELECTION_TOOL::Selectable(), BOARD_ITEM::SwapItemData(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and PCB_GROUP::WithinScope().

◆ GetPluralName()

wxString PCB_TUNING_PATTERN::GetPluralName ( ) const

inlineoverridevirtual

Implements PCB_GENERATOR.

Definition at line 263 of file pcb_tuning_pattern.cpp.

References _.

◆ GetPNSMode()

PNS::ROUTER_MODE PCB_TUNING_PATTERN::GetPNSMode ( )

inline

Definition at line 370 of file pcb_tuning_pattern.cpp.

References m_tuningMode, PNS::PNS_MODE_TUNE_DIFF_PAIR, PNS::PNS_MODE_TUNE_DIFF_PAIR_SKEW, and PNS::PNS_MODE_TUNE_SINGLE.

Referenced by DRAWING_TOOL::PlaceTuningPattern(), ShowPropertiesDialog(), and Update().

◆ GetPosition()

VECTOR2I PCB_GENERATOR::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 81 of file pcb_generator.h.

References PCB_GENERATOR::m_origin.

Referenced by DRAWING_TOOL::PlaceTuningPattern().

◆ GetPreviewItems()

std::vector< EDA_ITEM * > PCB_TUNING_PATTERN::GetPreviewItems	(	GENERATOR_TOOL *	aTool,
		PCB_BASE_EDIT_FRAME *	aFrame,
		bool	aStatusItemsOnly = `false`
	)

overridevirtual

◆ GetProperties()

const STRING_ANY_MAP PCB_TUNING_PATTERN::GetProperties ( ) const

overridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 1808 of file pcb_tuning_pattern.cpp.

◆ GetRowData()

std::vector< std::pair< wxString, wxVariant > > PCB_TUNING_PATTERN::GetRowData ( )

inlineoverridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 443 of file pcb_tuning_pattern.cpp.

References _HKI, PCB_GENERATOR::GetRowData(), m_lastNetName, and m_tuningInfo.

◆ GetSettings()

PNS::MEANDER_SETTINGS & PCB_TUNING_PATTERN::GetSettings ( )

inline

Definition at line 381 of file pcb_tuning_pattern.cpp.

References m_settings.

Referenced by DRAWING_TOOL::PlaceTuningPattern().

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

References EDA_ITEM::GetPosition().

◆ GetSpacing()

int PCB_TUNING_PATTERN::GetSpacing ( ) const

inline

Definition at line 408 of file pcb_tuning_pattern.cpp.

References m_settings, and PNS::MEANDER_SETTINGS::m_spacing.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 85 of file board_item.cpp.

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

Referenced by CONVERT_TOOL::CreatePolys().

◆ GetTargetLength()

std::optional< int > PCB_TUNING_PATTERN::GetTargetLength ( ) const

inline

Definition at line 411 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::LENGTH_UNCONSTRAINED, m_settings, PNS::MEANDER_SETTINGS::m_targetLength, and MINOPTMAX< T >::Opt().

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetTargetSkew()

int PCB_TUNING_PATTERN::GetTargetSkew ( ) const

inline

Definition at line 427 of file pcb_tuning_pattern.cpp.

References m_settings, PNS::MEANDER_SETTINGS::m_targetSkew, and MINOPTMAX< T >::Opt().

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 145 of file eda_item.h.

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

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

◆ GetTuningMode()

LENGTH_TUNING_MODE PCB_TUNING_PATTERN::GetTuningMode ( ) const

inline

Definition at line 368 of file pcb_tuning_pattern.cpp.

References m_tuningMode.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

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

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

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

◆ 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(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), ZONE_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), BOARD_ITEM::SetY(), TRACK_VIA_DESC::TRACK_VIA_DESC(), 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(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), FOOTPRINT_SEARCH_HANDLER::getResultCell(), ZONE_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), BOARD_ITEM::SetX(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

◆ 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(), hasDrilledHole(), DRC_RTREE::Insert(), BOARD_INSPECTION_TOOL::InspectClearance(), DRC_TEST_PROVIDER_PHYSICAL_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 216 of file board_item.h.

◆ HitTest() [1/2]

bool PCB_TUNING_PATTERN::HitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy
	)		const

inlineoverridevirtual

Test if aRect intersects this item.

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 340 of file pcb_tuning_pattern.cpp.

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

◆ HitTest() [2/2]

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

inlineoverridevirtual

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 335 of file pcb_tuning_pattern.cpp.

References SHAPE_LINE_CHAIN::Collide(), and getOutline().

◆ initBaseLine()

bool PCB_TUNING_PATTERN::initBaseLine	(	PNS::ROUTER *	aRouter,
		int	aLayer,
		BOARD *	aBoard,
		VECTOR2I &	aStart,
		VECTOR2I &	aEnd,
		NETINFO_ITEM *	aNet,
		std::optional< SHAPE_LINE_CHAIN > &	aBaseLine
	)

protected

Definition at line 933 of file pcb_tuning_pattern.cpp.

References PNS::NODE::AssembleLine(), PNS::LINE::CLine(), PNS::LINK_HOLDER::ContainsLink(), PNS::ROUTER::GetWorld(), pickSegment(), SHAPE_LINE_CHAIN_BASE::PointOnEdge(), snapToNearestTrack(), and SHAPE_LINE_CHAIN::Split().

Referenced by initBaseLines().

◆ initBaseLines()

bool PCB_TUNING_PATTERN::initBaseLines	(	PNS::ROUTER *	aRouter,
		int	aLayer,
		BOARD *	aBoard
	)

protected

Definition at line 973 of file pcb_tuning_pattern.cpp.

References DIFF_PAIR, DIFF_PAIR_SKEW, BOARD::DpCoupledNet(), BOARD_CONNECTED_ITEM::GetNet(), initBaseLine(), m_baseLine, m_baseLineCoupled, m_end, PCB_GENERATOR::m_origin, m_tuningMode, and snapToNearestTrack().

Referenced by EditStart(), and Update().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 111 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::m_flags.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), SCH_FIND_REPLACE_TOOL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), SYMBOL_EDIT_FRAME::FocusOnItem(), KIGFX::DS_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::SCH_PAINTER::getLineWidth(), KIGFX::SCH_PAINTER::setDeviceColors(), and SCH_FIND_REPLACE_TOOL::UpdateFind().

◆ 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(), BOARD_INSPECTION_TOOL::getItemDescription(), 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 110 of file eda_item.h.

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 194 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

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

◆ IsGroupableType()

bool PCB_GROUP::IsGroupableType ( KICAD_T aType )

staticinherited

Check if the proposed type can be added to a group.

Parameters

aType KICAD_T type to check

Returns: true if the type can belong to a group, false otherwise

Definition at line 49 of file pcb_group.cpp.

References PCB_ARC_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, and PCB_ZONE_T.

Referenced by PCB_GROUP::AddItem(), and BOARD_COMMIT::Push().

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Definition at line 296 of file board_item.h.

References BOARD_ITEM::m_isKnockout.

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_TEXT::GetBoundingBox(), PCB_TEXT::GetEffectiveShape(), FP_TEXT_GRID_TABLE::GetValueAsBool(), PCB_TEXT_DESC::PCB_TEXT_DESC(), BRDITEMS_PLOTTER::PlotBoardGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), PCB_TEXT::Serialize(), PCB_TEXT::TextHitTest(), and PCB_TEXT::TransformTextToPolySet().

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

Reimplemented in FOOTPRINT, and PAD.

Definition at line 74 of file board_item.cpp.

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

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 105 of file eda_item.h.

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), SCH_PIN::CalcEdit(), EDIT_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SCH_EDIT_TOOL::JustifyText(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Swap().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

References IS_NEW, and EDA_ITEM::m_flags.

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

◆ IsOnCopperLayer()

bool PCB_GROUP::IsOnCopperLayer ( ) const

inlineoverridevirtualinherited

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

Reimplemented from BOARD_ITEM.

Definition at line 131 of file pcb_group.h.

◆ IsOnLayer()

bool PCB_GROUP::IsOnLayer ( PCB_LAYER_ID aLayer ) const

overridevirtualinherited

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

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

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 316 of file pcb_group.cpp.

References PCB_GROUP::m_items.

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

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 113 of file eda_item.h.

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsRounded()

bool PCB_TUNING_PATTERN::IsRounded ( ) const

inline

Definition at line 439 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_cornerStyle, m_settings, and PNS::MEANDER_STYLE_ROUND.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 109 of file eda_item.h.

References EDA_ITEM::m_flags, and SELECTED.

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

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 167 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsSingleSided()

bool PCB_TUNING_PATTERN::IsSingleSided ( ) const

inline

Definition at line 436 of file pcb_tuning_pattern.cpp.

References m_settings, and PNS::MEANDER_SETTINGS::m_singleSided.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( ) const

inlinevirtualinherited

Reimplemented in PCB_VIA.

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

Definition at line 175 of file eda_item.h.

References EDA_ITEM::m_structType, and SCH_LOCATE_ANY_T.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), ROUTER_TOOL::CanInlineDrag(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_FIELD::GetCanonicalName(), SCH_FIELD::GetName(), SCH_FIELD::GetShownText(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), SCH_ITEM::IsType(), PAD::IsType(), PCB_FIELD::IsType(), PCB_SHAPE::IsType(), PCB_TEXT::IsType(), PCB_TEXTBOX::IsType(), PCB_VIA::IsType(), EE_POINT_EDITOR::Main(), PL_POINT_EDITOR::Main(), CONVERT_TOOL::makePolysFromChainedSegs(), EE_SELECTION_TOOL::RequestSelection(), SCH_FIELD::SetId(), SCH_COMMIT::Stage(), SCH_BASE_FRAME::UpdateItem(), and EDA_ITEM::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 295 of file eda_item.h.

References EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 315 of file eda_item.h.

References EDA_ITEM::Visit().

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

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

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

◆ MakeEditPoints()

bool PCB_TUNING_PATTERN::MakeEditPoints ( std::shared_ptr< EDIT_POINTS > points ) const

overridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 1490 of file pcb_tuning_pattern.cpp.

References SEG::A, SEG::B, DIFF_PAIR, IGNORE_GRID, KiROUND(), m_baseLine, m_baseLineCoupled, m_diffPairGap, m_end, PNS::MEANDER_SETTINGS::m_initialSide, PNS::MEANDER_SETTINGS::m_maxAmplitude, PCB_GENERATOR::m_origin, m_settings, PNS::MEANDER_SETTINGS::m_spacing, m_trackWidth, m_tuningMode, and VECTOR2< T >::Resize().

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 375 of file eda_item.h.

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 123 of file eda_item.cpp.

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

◆ Move()

void PCB_TUNING_PATTERN::Move ( const VECTOR2I & aMoveVector )

inlineoverridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 290 of file pcb_tuning_pattern.cpp.

References EDA_ITEM::HasFlag(), IN_EDIT, m_baseLine, m_baseLineCoupled, m_end, PCB_GENERATOR::m_origin, and PCB_GROUP::Move().

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

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

References EDA_ITEM::GetClass().

◆ operator==()

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

overridevirtualinherited

Implements BOARD_ITEM.

Definition at line 429 of file pcb_group.cpp.

References PCB_GROUP::m_items, and EDA_ITEM::Type().

◆ recoverBaseline()

bool PCB_TUNING_PATTERN::recoverBaseline ( PNS::ROUTER * aRouter )

protected

◆ Remove()

void PCB_TUNING_PATTERN::Remove	(	GENERATOR_TOOL *	aTool,
		BOARD *	aBoard,
		BOARD_COMMIT *	aCommit
	)

overridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 1043 of file pcb_tuning_pattern.cpp.

References COMMIT::Add(), baselineValid(), CHT_UNGROUP, GENERATOR_TOOL_PNS_PROXY::ClearRouterChanges(), DIFF_PAIR, empty(), PCB_GROUP::GetItems(), BOARD_ITEM::GetLayer(), GENERATOR_TOOL_PNS_PROXY::GetRouterChanges(), group, IN_EDIT, m_baseLine, m_baseLineCoupled, m_tuningMode, BOARD_COMMIT::Push(), recoverBaseline(), COMMIT::Remove(), removeToBaseline(), PNS::TOOL_BASE::Router(), EDA_ITEM::SetFlags(), BOARD_COMMIT::Stage(), and PNS::ROUTER::SyncWorld().

◆ RemoveAll()

void PCB_GROUP::RemoveAll ( )

inherited

Definition at line 108 of file pcb_group.cpp.

References PCB_GROUP::m_items.

Referenced by DIALOG_GROUP_PROPERTIES::TransferDataFromWindow().

◆ RemoveItem()

bool PCB_GROUP::RemoveItem ( BOARD_ITEM * aItem )

virtualinherited

Remove item from group.

Returns: true if item was removed (false if item was not in the group).

Definition at line 95 of file pcb_group.cpp.

References PCB_GROUP::m_items, and BOARD_ITEM::SetParentGroup().

Referenced by PCB_GROUP::AddItem(), PCB_GENERATOR::AddItem(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_CONTROL::Paste(), BOARD_COMMIT::Push(), BOARD::Remove(), and FOOTPRINT::Remove().

◆ removeToBaseline()

bool PCB_TUNING_PATTERN::removeToBaseline	(	PNS::ROUTER *	aRouter,
		int	aLayer,
		SHAPE_LINE_CHAIN &	aBaseLine
	)

protected

Definition at line 1006 of file pcb_tuning_pattern.cpp.

References PNS::NODE::Add(), PNS::ROUTER_IFACE::AddItem(), SHAPE_LINE_CHAIN::Append(), SHAPE_LINE_CHAIN::CPoint(), PNS::ROUTER::GetInterface(), getPNSLine(), PNS::ROUTER::GetWorld(), PNS::LINK_HOLDER::Links(), PNS::NODE::Remove(), PNS::ROUTER_IFACE::RemoveItem(), SHAPE_LINE_CHAIN::Simplify(), and SHAPE_LINE_CHAIN::Split().

Referenced by Remove().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 157 of file eda_item.h.

◆ Replace() [1/2]

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

inlinevirtualinherited

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

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

Parameters

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

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

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

Definition at line 402 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 186 of file eda_item.cpp.

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

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

◆ resetToBaseline()

bool PCB_TUNING_PATTERN::resetToBaseline	(	GENERATOR_TOOL *	aTool,
		int	aLayer,
		SHAPE_LINE_CHAIN &	aBaseLine,
		bool	aPrimary
	)

protected

◆ Rotate()

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

inlineoverridevirtual

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from BOARD_ITEM.

Definition at line 307 of file pcb_tuning_pattern.cpp.

References EDA_ITEM::HasFlag(), IN_EDIT, m_baseLine, m_baseLineCoupled, m_end, PCB_GENERATOR::m_origin, PCB_GROUP::Rotate(), and RotatePoint().

◆ RunOnChildren()

void PCB_GROUP::RunOnChildren ( const std::function< void(BOARD_ITEM *)> & aFunction ) const

overridevirtualinherited

Invoke a function on all descendants.

Note: This function should not add or remove items.

Reimplemented from BOARD_ITEM.

Definition at line 391 of file pcb_group.cpp.

References PCB_GROUP::m_items.

Referenced by PCB_SELECTION_TOOL::EnterGroup(), and PCB_GROUP::SetLocked().

◆ RunOnDescendants()

void PCB_GROUP::RunOnDescendants	(	const std::function< void(BOARD_ITEM *)> &	aFunction,
		int	aDepth = `0`
	)		const

overridevirtualinherited

Invoke a function on all descendants.

Note: This function should not add or remove items.

Reimplemented from BOARD_ITEM.

Definition at line 405 of file pcb_group.cpp.

References PCB_GROUP::m_items, and PCB_GROUP_T.

◆ Serialize()

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

inlinevirtualinherited

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 SCH_LABEL, SCH_DIRECTIVE_LABEL, SCH_GLOBALLABEL, SCH_HIERLABEL, SCH_LINE, BOARD_STACKUP, FOOTPRINT, PAD, PCB_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TRACK, PCB_ARC, and PCB_VIA.

Definition at line 43 of file serializable.h.

Referenced by API_HANDLER_SCH::handleCreateUpdateItemsInternal(), and API_HANDLER_PCB::handleCreateUpdateItemsInternal().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 76 of file inspectable.h.

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 59 of file inspectable.h.

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetCornerRadiusPercentage()

void PCB_TUNING_PATTERN::SetCornerRadiusPercentage ( int aValue )

inline

Definition at line 434 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_cornerRadiusPercentage, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetEnd()

void PCB_TUNING_PATTERN::SetEnd ( const VECTOR2I & aValue )

inline

Definition at line 360 of file pcb_tuning_pattern.cpp.

References m_end.

Referenced by DRAWING_TOOL::PlaceTuningPattern().

◆ SetEndX()

void PCB_TUNING_PATTERN::SetEndX ( int aValue )

inline

Definition at line 363 of file pcb_tuning_pattern.cpp.

References m_end, and VECTOR2< T >::x.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetEndY()

void PCB_TUNING_PATTERN::SetEndY ( int aValue )

inline

Definition at line 366 of file pcb_tuning_pattern.cpp.

References m_end, and VECTOR2< T >::y.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 126 of file eda_item.h.

References EDA_ITEM::m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 152 of file view_item.h.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 193 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

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

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 276 of file board_item.cpp.

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

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

◆ SetInitialSide()

void PCB_TUNING_PATTERN::SetInitialSide ( PNS::MEANDER_SIDE aValue )

inline

Definition at line 406 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_initialSide, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Definition at line 297 of file board_item.h.

References BOARD_ITEM::m_isKnockout.

Referenced by ZONE_FILLER::addKnockout(), PCB_TEXT::Deserialize(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_TEXT_DESC::PCB_TEXT_DESC(), and FP_TEXT_GRID_TABLE::SetValueAsBool().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 159 of file eda_item.h.

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

◆ SetLayer()

void PCB_GENERATOR::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtualinherited

Set the layer this item is on.

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

Parameters

aLayer The layer number.

Reimplemented from BOARD_ITEM.

Definition at line 148 of file pcb_generator.cpp.

References BOARD_ITEM::m_layer.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::resolveGroups().

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( LSET aLayers )

inlinevirtualinherited

Reimplemented in PAD, PCB_VIA, and ZONE.

Definition at line 239 of file board_item.h.

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

Referenced by GLOBAL_EDIT_TOOL::swapBoardItem(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLocked()

void PCB_GROUP::SetLocked ( bool aLocked )

overridevirtualinherited

Reimplemented from BOARD_ITEM.

Definition at line 183 of file pcb_group.cpp.

References PCB_GROUP::RunOnChildren(), and BOARD_ITEM::SetLocked().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::loadGroups(), BOARD_EDITOR_CONTROL::modifyLockSelected(), and DIALOG_GROUP_PROPERTIES::TransferDataFromWindow().

◆ SetMaxAmplitude()

void PCB_TUNING_PATTERN::SetMaxAmplitude ( int aValue )

inline

Definition at line 395 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_maxAmplitude, PNS::MEANDER_SETTINGS::m_minAmplitude, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC(), DRAWING_TOOL::PlaceTuningPattern(), and UpdateFromEditPoints().

◆ SetMinAmplitude()

void PCB_TUNING_PATTERN::SetMinAmplitude ( int aValue )

inline

Definition at line 384 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_maxAmplitude, PNS::MEANDER_SETTINGS::m_minAmplitude, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

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

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

◆ SetName()

void PCB_GROUP::SetName ( const wxString & aName )

inlineinherited

Definition at line 66 of file pcb_group.h.

References PCB_GROUP::m_name.

Referenced by createBoard(), CADSTAR_PCB_ARCHIVE_LOADER::createUniqueGroupID(), CADSTAR_PCB_ARCHIVE_LOADER::loadGroups(), PCB_GROUP_DESC::PCB_GROUP_DESC(), and DIALOG_GROUP_PROPERTIES::TransferDataFromWindow().

◆ SetOverrideCustomRules()

void PCB_TUNING_PATTERN::SetOverrideCustomRules ( bool aOverride )

inline

Definition at line 431 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_overrideCustomRules, and m_settings.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and NETINFO_ITEM.

Definition at line 103 of file eda_item.h.

References EDA_ITEM::m_parent.

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

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

Definition at line 90 of file board_item.h.

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), PCB_GENERATOR::AddItem(), ZONE_FILLER::buildThermalSpokes(), PCB_IO_KICAD_SEXPR::FootprintSave(), GENDRILL_WRITER_BASE::genDrillMapFile(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), TRACKS_CLEANER::mergeCollinearSegments(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GROUP::RemoveItem(), BOARD_COMMIT::Revert(), CLIPBOARD_IO::SaveSelection(), BOARD_ITEM::SwapItemData(), DIALOG_PAD_PROPERTIES::~DIALOG_PAD_PROPERTIES(), and TEST_BOARD_ITEM_FIXTURE::~TEST_BOARD_ITEM_FIXTURE().

◆ SetPosition()

void PCB_GENERATOR::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 82 of file pcb_generator.h.

References PCB_GENERATOR::m_origin.

Referenced by DRAWING_TOOL::PlaceTuningPattern().

◆ SetProperties()

void PCB_TUNING_PATTERN::SetProperties ( const STRING_ANY_MAP & aProps )

overridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 1847 of file pcb_tuning_pattern.cpp.

◆ SetRounded()

void PCB_TUNING_PATTERN::SetRounded ( bool aFlag )

inline

Definition at line 440 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::m_cornerStyle, m_settings, PNS::MEANDER_STYLE_CHAMFER, and PNS::MEANDER_STYLE_ROUND.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetSingleSided()

void PCB_TUNING_PATTERN::SetSingleSided ( bool aValue )

inline

Definition at line 437 of file pcb_tuning_pattern.cpp.

References m_settings, and PNS::MEANDER_SETTINGS::m_singleSided.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetSpacing()

void PCB_TUNING_PATTERN::SetSpacing ( int aValue )

inline

Definition at line 409 of file pcb_tuning_pattern.cpp.

References m_settings, and PNS::MEANDER_SETTINGS::m_spacing.

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC(), DRAWING_TOOL::PlaceTuningPattern(), and UpdateFromEditPoints().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 91 of file board_item.cpp.

◆ SetTargetLength()

void PCB_TUNING_PATTERN::SetTargetLength ( std::optional< int > aValue )

inline

Definition at line 419 of file pcb_tuning_pattern.cpp.

References PNS::MEANDER_SETTINGS::LENGTH_UNCONSTRAINED, m_settings, and PNS::MEANDER_SETTINGS::SetTargetLength().

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetTargetSkew()

void PCB_TUNING_PATTERN::SetTargetSkew ( int aValue )

inline

Definition at line 428 of file pcb_tuning_pattern.cpp.

References m_settings, and PNS::MEANDER_SETTINGS::SetTargetSkew().

Referenced by PCB_TUNING_PATTERN_DESC::PCB_TUNING_PATTERN_DESC().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 117 of file board_item.h.

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

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

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 123 of file board_item.h.

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

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

◆ ShowPropertiesDialog()

void PCB_TUNING_PATTERN::ShowPropertiesDialog ( PCB_BASE_EDIT_FRAME * aEditFrame )

overridevirtual

◆ Similarity()

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

overridevirtualinherited

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

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

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

Implements BOARD_ITEM.

Definition at line 456 of file pcb_group.cpp.

References PCB_GROUP::m_items, PCB_GROUP::Similarity(), and EDA_ITEM::Type().

Referenced by PCB_GROUP::Similarity().

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

◆ StyleFromSettings()

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

inlinevirtualinherited

Reimplemented in PCB_SHAPE, PCB_TEXT, and PCB_TEXTBOX.

Definition at line 302 of file board_item.h.

◆ swapData()

void PCB_TUNING_PATTERN::swapData ( BOARD_ITEM * aImage )

inlineoverrideprotectedvirtual

Reimplemented from BOARD_ITEM.

Definition at line 462 of file pcb_tuning_pattern.cpp.

References PCB_GENERATOR_T, and EDA_ITEM::Type().

◆ SwapItemData()

void BOARD_ITEM::SwapItemData ( BOARD_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

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

Parameters

aImage the item image which contains data to swap.

Definition at line 175 of file board_item.cpp.

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

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

◆ TopLevelGroup()

PCB_GROUP * PCB_GROUP::TopLevelGroup	(	BOARD_ITEM *	aItem,
		PCB_GROUP *	aScope,
		bool	isFootprintEditor
	)

staticinherited

Definition at line 150 of file pcb_group.cpp.

References getNestedGroup().

Referenced by PCB_SELECTION_TOOL::FilterCollectorForHierarchy().

◆ TransformShapeToPolygon()

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

virtualinherited

Convert the item shape to a closed polygon.

Circles and arcs are approximated by segments.

Parameters

aBuffer	a buffer to store the polygon.
aClearance	the clearance around the 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_DIMENSION_BASE, PCB_SHAPE, PCB_TARGET, PCB_TRACK, ZONE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, and PAD.

Definition at line 205 of file board_item.cpp.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), ZONE_FILLER::addKnockout(), FOOTPRINT::CoverageRatio(), enclosedByAreaFunc(), FOOTPRINT::GetCoverageArea(), process(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), and DRC_TEST_PROVIDER_SLIVER_CHECKER::Run().

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

References EDA_ITEM::m_structType.

◆ Update()

bool PCB_TUNING_PATTERN::Update	(	GENERATOR_TOOL *	aTool,
		BOARD *	aBoard,
		BOARD_COMMIT *	aCommit
	)

overridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 1267 of file pcb_tuning_pattern.cpp.

References _, baselineValid(), DIFF_PAIR, PNS::SIZES_SETTINGS::DiffPairGap(), EDA_ITEM::GetFlags(), PNS::TOOL_BASE::GetInterface(), BOARD_ITEM::GetLayer(), TOOL_BASE::GetManager(), PNS_KICAD_IFACE::GetNetName(), GetPNSMode(), GENERATOR_TOOL_PNS_PROXY::GetRouterChanges(), TOOL_MANAGER::GetSettings(), TOOL_MANAGER::GetView(), KIGFX::VIEW::Hide(), IN_EDIT, initBaseLines(), m_baseLine, m_baseLineCoupled, m_diffPairGap, m_end, PNS::MEANDER_SETTINGS::m_keepEndpoints, m_lastNetName, PCB_GENERATOR::m_origin, m_settings, APP_SETTINGS_BASE::m_System, m_trackWidth, m_tuningInfo, m_tuningMode, m_tuningStatus, PNS::MEANDER_PLACER_BASE::MeanderSettings(), EDA_UNIT_UTILS::UI::MessageTextFromValue(), PNS::ROUTER::Move(), PNS::ITEM::Net(), pcbIUScale, pickSegment(), PNS::ROUTER::Placer(), resetToBaseline(), PNS::TOOL_BASE::Router(), PNS::ROUTER::RoutingInProgress(), PNS::ROUTER::SetMode(), PNS_KICAD_IFACE_BASE::SetStartLayer(), PNS::ROUTER::Sizes(), PNS::ROUTER::StartRouting(), PNS::ROUTER::StopRouting(), PNS::MEANDER_PLACER_BASE::TOO_LONG, PNS::MEANDER_PLACER_BASE::TOO_SHORT, PNS::MEANDER_PLACER_BASE::TUNED, PNS::MEANDER_PLACER_BASE::TuningResult(), PNS::MEANDER_PLACER_BASE::TuningStatus(), APP_SETTINGS_BASE::SYSTEM::units, PNS::MEANDER_PLACER_BASE::UpdateSettings(), and PNS::LINKED_ITEM::Width().

Referenced by DRAWING_TOOL::PlaceTuningPattern(), and ShowPropertiesDialog().

◆ UpdateEditPoints()

bool PCB_TUNING_PATTERN::UpdateEditPoints ( std::shared_ptr< EDIT_POINTS > aEditPoints )

overridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 1589 of file pcb_tuning_pattern.cpp.

References SEG::A, SEG::B, DIFF_PAIR, KiROUND(), m_baseLine, m_baseLineCoupled, m_diffPairGap, m_end, PNS::MEANDER_SETTINGS::m_initialSide, PNS::MEANDER_SETTINGS::m_maxAmplitude, PCB_GENERATOR::m_origin, m_settings, PNS::MEANDER_SETTINGS::m_spacing, m_trackWidth, m_tuningMode, and VECTOR2< T >::Resize().

◆ UpdateFromEditPoints()

bool PCB_TUNING_PATTERN::UpdateFromEditPoints	(	std::shared_ptr< EDIT_POINTS >	aEditPoints,
		BOARD_COMMIT *	aCommit
	)

overridevirtual

Reimplemented from PCB_GENERATOR.

Definition at line 1533 of file pcb_tuning_pattern.cpp.

References SEG::A, SEG::B, DIFF_PAIR, KiROUND(), SEG::LineDistance(), m_baseLine, m_baseLineCoupled, m_diffPairGap, m_end, PNS::MEANDER_SETTINGS::m_initialSide, PCB_GENERATOR::m_origin, m_settings, m_trackWidth, m_tuningMode, PNS::MEANDER_SIDE_LEFT, PNS::MEANDER_SIDE_RIGHT, EDA_IU_SCALE::mmToIU(), pcbIUScale, SetMaxAmplitude(), SetSpacing(), and SEG::Side().

◆ ViewBBox()

const BOX2I PCB_TUNING_PATTERN::ViewBBox ( ) const

inlineoverridevirtual

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

Returns: the current bounding box.

Reimplemented from EDA_ITEM.

Definition at line 353 of file pcb_tuning_pattern.cpp.

References GetBoundingBox().

◆ ViewDraw()

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

finaloverridevirtual

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 from KIGFX::VIEW_ITEM.

Definition at line 1763 of file pcb_tuning_pattern.cpp.

References SEG::A, SEG::B, DIFF_PAIR, KIGFX::PREVIEW::DRAW_CONTEXT::DrawLineDashed(), getOutline(), EDA_ITEM::HasFlag(), IN_EDIT, EDA_ITEM::IsNew(), EDA_ITEM::IsSelected(), KiROUND(), m_baseLine, m_baseLineCoupled, m_end, PCB_GENERATOR::m_origin, m_tuningMode, EDA_IU_SCALE::mmToIU(), pcbIUScale, EDIT_POINT::POINT_SIZE, SHAPE_LINE_CHAIN::Segment(), SHAPE_LINE_CHAIN::SegmentCount(), and KIGFX::VIEW::ToWorld().

◆ ViewGetLayers()

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

inlineoverridevirtual

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

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 328 of file pcb_tuning_pattern.cpp.

References BOARD_ITEM::GetLayer(), and LAYER_ANCHOR.

◆ ViewGetLOD()

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

overridevirtualinherited

Reimplemented from KIGFX::VIEW_ITEM.

Definition at line 336 of file pcb_group.cpp.

References KIGFX::VIEW::IsLayerVisible(), and LAYER_ANCHOR.

◆ viewPrivData()

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

inlineinherited

◆ Visit()

INSPECT_RESULT PCB_GROUP::Visit	(	INSPECTOR	aInspector,
		void *	aTestData,
		const std::vector< KICAD_T > &	aScanTypes
	)

overridevirtualinherited

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

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 289 of file pcb_group.cpp.

References EDA_ITEM::Type().

◆ WithinScope()

bool PCB_GROUP::WithinScope	(	BOARD_ITEM *	aItem,
		PCB_GROUP *	aScope,
		bool	isFootprintEditor
	)

staticinherited

Definition at line 156 of file pcb_group.cpp.

References getClosestGroup(), getNestedGroup(), BOARD_ITEM::GetParentGroup(), and group.

Referenced by PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), and PCB_SELECTION_TOOL::select().

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 127 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by EE_SELECTION_TOOL::selectMultiple().

Member Data Documentation

◆ DISPLAY_NAME

const wxString PCB_TUNING_PATTERN::DISPLAY_NAME = _HKI( "Tuning Pattern" )

static

Definition at line 246 of file pcb_tuning_pattern.cpp.

Referenced by PCB_TUNING_PATTERN().

◆ GENERATOR_TYPE

const wxString PCB_TUNING_PATTERN::GENERATOR_TYPE = wxS( "tuning_pattern" )

static

Definition at line 245 of file pcb_tuning_pattern.cpp.

Referenced by PCB_TUNING_PATTERN().

◆ m_baseLine

std::optional<SHAPE_LINE_CHAIN> PCB_TUNING_PATTERN::m_baseLine

protected

Definition at line 491 of file pcb_tuning_pattern.cpp.

Referenced by baselineValid(), getOutline(), GetProperties(), initBaseLines(), MakeEditPoints(), Move(), recoverBaseline(), Remove(), resetToBaseline(), Rotate(), SetProperties(), Update(), UpdateEditPoints(), UpdateFromEditPoints(), and ViewDraw().

◆ m_baseLineCoupled

std::optional<SHAPE_LINE_CHAIN> PCB_TUNING_PATTERN::m_baseLineCoupled

protected

Definition at line 492 of file pcb_tuning_pattern.cpp.

Referenced by baselineValid(), getOutline(), GetProperties(), initBaseLines(), MakeEditPoints(), Move(), recoverBaseline(), Remove(), resetToBaseline(), Rotate(), SetProperties(), Update(), UpdateEditPoints(), UpdateFromEditPoints(), and ViewDraw().

◆ m_diffPairGap

int PCB_TUNING_PATTERN::m_diffPairGap

protected

Definition at line 495 of file pcb_tuning_pattern.cpp.

Referenced by getOutline(), GetProperties(), MakeEditPoints(), SetProperties(), Update(), UpdateEditPoints(), and UpdateFromEditPoints().

◆ m_end

VECTOR2I PCB_TUNING_PATTERN::m_end

protected

Definition at line 487 of file pcb_tuning_pattern.cpp.

Referenced by EditPush(), GetEnd(), GetEndX(), GetEndY(), GetProperties(), initBaseLines(), MakeEditPoints(), Move(), PCB_TUNING_PATTERN(), resetToBaseline(), Rotate(), SetEnd(), SetEndX(), SetEndY(), SetProperties(), Update(), UpdateEditPoints(), UpdateFromEditPoints(), and ViewDraw().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 490 of file eda_item.h.

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

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 166 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 489 of file eda_item.h.

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

◆ m_generatorType

wxString PCB_GENERATOR::m_generatorType

protectedinherited

Definition at line 120 of file pcb_generator.h.

Referenced by PCB_GENERATOR::GetGeneratorType(), and PCB_TUNING_PATTERN().

◆ m_group

PCB_GROUP* BOARD_ITEM::m_group

protectedinherited

Definition at line 393 of file board_item.h.

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

◆ m_isKnockout

bool BOARD_ITEM::m_isKnockout

protectedinherited

Definition at line 389 of file board_item.h.

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

◆ m_isLocked

bool BOARD_ITEM::m_isLocked

protectedinherited

Definition at line 391 of file board_item.h.

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

◆ m_items

std::unordered_set<BOARD_ITEM*> PCB_GROUP::m_items

protectedinherited

◆ m_lastNetName

wxString PCB_TUNING_PATTERN::m_lastNetName

protected

Definition at line 499 of file pcb_tuning_pattern.cpp.

Referenced by GetProperties(), GetRowData(), recoverBaseline(), SetProperties(), and Update().

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 388 of file board_item.h.

Referenced by PCB_VIA::ConditionallyFlashed(), PCB_VIA::Deserialize(), PCB_VIA::FlashLayer(), FOOTPRINT::FOOTPRINT(), PCB_VIA::GetDrillConstraint(), BOARD_ITEM::GetLayer(), PCB_SHAPE::GetLayer(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetLayerSet(), PCB_VIA::GetLayerSet(), GetMsgPanelInfo(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PAD::GetPrincipalLayer(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), BOARD_ITEM::IsOnLayer(), PCB_VIA::IsOnLayer(), PCB_SHAPE::IsType(), PCB_VIA::LayerPair(), PCB_REFERENCE_IMAGE::operator==(), PCB_SHAPE::operator==(), PCB_TARGET::operator==(), PCB_ARC::operator==(), PCB_VIA::operator==(), PCB_TRACK::operator==(), PCB_DIMENSION_BASE::PCB_DIMENSION_BASE(), PCB_TARGET::PCB_TARGET(), recoverBaseline(), PCB_VIA::SanitizeLayers(), PAD::Serialize(), PCB_VIA::Serialize(), PCB_MARKER::SerializeToString(), BOARD_ITEM::SetLayer(), PCB_GENERATOR::SetLayer(), PCB_VIA::SetLayerPair(), PCB_VIA::SetLayerSet(), PCB_VIA::SetTopLayer(), PCB_REFERENCE_IMAGE::Similarity(), PCB_TRACK::Similarity(), PCB_ARC::Similarity(), PCB_VIA::Similarity(), PCB_SHAPE::swapData(), PCB_TABLE::swapData(), PCB_REFERENCE_IMAGE::swapData(), PCB_VIA::TopLayer(), BOARD_ITEM::ViewGetLayers(), FOOTPRINT::ViewGetLayers(), PCB_REFERENCE_IMAGE::ViewGetLayers(), FOOTPRINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), and PCB_TRACK::ViewGetLOD().

◆ m_name

wxString PCB_GROUP::m_name

protectedinherited

Definition at line 217 of file pcb_group.h.

Referenced by PCB_GROUP::GetItemDescription(), PCB_GROUP::GetMsgPanelInfo(), PCB_GROUP::GetName(), PCB_TUNING_PATTERN(), and PCB_GROUP::SetName().

◆ m_origin

VECTOR2I PCB_GENERATOR::m_origin

protectedinherited

Definition at line 122 of file pcb_generator.h.

Referenced by EditStart(), PCB_GENERATOR::GetPosition(), PCB_GENERATOR::GetProperties(), initBaseLines(), MakeEditPoints(), Move(), PCB_GENERATOR::Move(), resetToBaseline(), Rotate(), PCB_GENERATOR::SetPosition(), PCB_GENERATOR::SetProperties(), Update(), UpdateEditPoints(), UpdateFromEditPoints(), and ViewDraw().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 488 of file eda_item.h.

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

◆ m_settings

PNS::MEANDER_SETTINGS PCB_TUNING_PATTERN::m_settings

protected

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

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

◆ m_trackWidth

int PCB_TUNING_PATTERN::m_trackWidth

protected

Definition at line 494 of file pcb_tuning_pattern.cpp.

Referenced by getOutline(), GetProperties(), MakeEditPoints(), SetProperties(), Update(), UpdateEditPoints(), and UpdateFromEditPoints().

◆ m_tuningInfo

wxString PCB_TUNING_PATTERN::m_tuningInfo

protected

Definition at line 500 of file pcb_tuning_pattern.cpp.

Referenced by GetProperties(), GetRowData(), SetProperties(), and Update().

◆ m_tuningMode

LENGTH_TUNING_MODE PCB_TUNING_PATTERN::m_tuningMode

protected

Definition at line 497 of file pcb_tuning_pattern.cpp.

Referenced by baselineValid(), EditStart(), GetMsgPanelInfo(), getOutline(), GetPNSMode(), GetPreviewItems(), GetProperties(), GetTuningMode(), initBaseLines(), MakeEditPoints(), recoverBaseline(), Remove(), SetProperties(), Update(), UpdateEditPoints(), UpdateFromEditPoints(), and ViewDraw().

◆ m_tuningStatus

PNS::MEANDER_PLACER_BASE::TUNING_STATUS PCB_TUNING_PATTERN::m_tuningStatus

protected

Definition at line 502 of file pcb_tuning_pattern.cpp.

Referenced by GetProperties(), SetProperties(), and Update().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 485 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 165 of file view_item.h.

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

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

Definition at line 169 of file board_item.h.

Referenced by BOARD::GetPosition().

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

pcb_tuning_pattern.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_TUNING_PATTERN()

Member Function Documentation

◆ AddItem()

◆ baselineValid()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ CreateNew()

◆ DeepClone()

◆ DeepDuplicate()

◆ DeleteStructure()

◆ Deserialize()

◆ Duplicate()

◆ EditPush()

◆ EditRevert()

◆ EditStart()

◆ Flip()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ GetCornerRadiusPercentage()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveShape()

◆ GetEnd()

◆ GetEndX()

◆ GetEndY()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFontMetrics()

◆ GetForcedTransparency()

◆ GetFPRelativePosition()

◆ GetFriendlyName()

◆ GetGeneratorType()

◆ GetInitialSide()

◆ GetItemDescription()

◆ GetItems() [1/2]

◆ GetItems() [2/2]

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetMaxAmplitude()

◆ GetMenuImage()

◆ GetMinAmplitude()

◆ GetMsgPanelInfo()

◆ GetName()

◆ getOutline()

◆ GetOverrideCustomRules()

◆ GetParent()

◆ GetParentAsString()

◆ GetParentFootprint()

◆ GetParentGroup()

◆ GetPluralName()

◆ GetPNSMode()

◆ GetPosition()

◆ GetPreviewItems()

◆ GetProperties()

◆ GetRowData()

◆ GetSettings()

◆ GetSortPosition()

◆ GetSpacing()

◆ GetStroke()