#include <pcb_generator.h>

Inheritance diagram for PCB_GENERATOR_POLY:

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

Public Member Functions
	PCB_GENERATOR_POLY (BOARD_ITEM *aParent, PCB_LAYER_ID aLayer)

const SHAPE_POLY_SET &	Outline () const

SHAPE_POLY_SET &	Outline ()

void	SetOutline (const SHAPE_POLY_SET &aOutline)

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

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

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

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

PCB_GENERATOR *	DeepClone () const

virtual void	EditStart (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit)=0

virtual bool	Update (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit)=0

virtual void	EditFinish (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit)=0

virtual void	EditCancel (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit)=0

virtual void	Remove (GENERATOR_TOOL aTool, BOARD aBoard, BOARD_COMMIT *aCommit)=0

virtual bool	ChildrenAreIndividuallySelectable () const

virtual ACTION_MENU *	GetChildContextMenu (TOOL_INTERACTIVE *aTool) const
	Get a context menu when interacting with a generator child.

virtual bool	ChildrenAreReadOnly () const

virtual std::vector< std::pair< wxString, const BOARD_ITEM * > >	GetTemplateItems () const
	Named template items used by the generator.

virtual void	SetTemplateItem (const wxString &aName, std::unique_ptr< BOARD_ITEM > aItem)
	Insert a template item (from board file loading)

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

virtual bool	MakeEditPoints (EDIT_POINTS &aEditPoints) const

virtual bool	UpdateFromEditPoints (EDIT_POINTS &aEditPoints)

virtual bool	UpdateEditPoints (EDIT_POINTS &aEditPoints)

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

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPos) override

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

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

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

virtual wxString	GetGeneratorType () const

virtual bool	LayerFollowsMembers () const

virtual bool	CanDuplicate () const

virtual const STRING_ANY_MAP	GetProperties () const

virtual void	SetProperties (const STRING_ANY_MAP &aProps)

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

virtual void	ShowPropertiesDialog (PCB_BASE_EDIT_FRAME *aEditFrame)

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

virtual wxString	GetPluralName () const =0

virtual wxString	GetCommitMessage () const =0

wxString	GetClass () const override
	Return the class name.

bool	IsDirty () const
	Dirty flag system to for determining if generator output is not up to date It is up to each generator whether or not to actually use this flag.

void	MarkDirty ()

void	ClearDirty ()

virtual void	OnZoneFillChanged (const std::vector< ZONE * > &aZones)
	Callback to be informed zones have changed.

virtual std::vector< ZONE * >	GetZonesNeedingRefillAfterUpdate () const
	Zones that need to be refilled after the generator runs Update()

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

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

bool	DeserializeGroup (const google::protobuf::Any &aContainer, COMMIT *aCommit) override
	Deserializes the given protobuf message into this group.

EDA_ITEM *	AsEdaItem () override

std::unordered_set< BOARD_ITEM * >	GetBoardItems () const

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

bool	operator== (const PCB_GROUP &aOther) const

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

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

bool	IsOnCopperLayer () const override

void	SetLocked (bool aLocked) override

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

PCB_GROUP *	DeepDuplicate (bool addToParentGroup, BOARD_COMMIT aCommit=nullptr, std::map< KIID, KIID > aKIIDMap=nullptr) const

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

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

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

bool	HitTest (const SHAPE_LINE_CHAIN &aPoly, bool aContained) const override
	Test if aPosition is inside or on the boundary of this item.

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

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.

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

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

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

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

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

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

virtual void	CopyFrom (const BOARD_ITEM *aOther)

bool	IsGroupableType () const

int	GetX () const

int	GetY () const

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

void	SetX (int aX)

void	SetY (int aY)

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

virtual bool	HasHole () const

virtual bool	HasDrilledHole () const

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

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

BOARD_ITEM_CONTAINER *	GetParent () const

FOOTPRINT *	GetParentFootprint () const

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

void	ResetUuidDirect ()

void	SetUuid (const KIID &aUuid)

void	ResetUuid ()

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

VECTOR2I	GetFPRelativePosition () const

void	SetFPRelativePosition (const VECTOR2I &aPos)

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

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

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

const KIFONT::METRICS &	GetFontMetrics () const

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

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

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

virtual void	SetLayerSet (const LSET &aLayers)

bool	IsSideSpecific () const

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

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

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

bool	IsLocked () const override

bool	IsIndexedInBoard () const

int	GetMaxError () const

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

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

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

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

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

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

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

virtual BOARD *	GetBoard ()

wxString	GetParentAsString () const
	For "parent" property.

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

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

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

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

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

KICAD_T	Type () const
	Returns the type of object.

virtual void	SetParent (EDA_ITEM *aParent)

virtual void	SetParentGroup (EDA_GROUP *aGroup)

virtual EDA_GROUP *	GetParentGroup () const

KIID	GetParentGroupId () const

bool	HasSelectedAncestorGroup () const

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

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

void	SetNetHighlighted (bool aHighlighted)

bool	IsRollover () const

VECTOR2I	GetRolloverPos () const

void	SetIsRollover (bool aIsRollover, const VECTOR2I &aMousePos)

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

virtual void	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

virtual void	ClearTempFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

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

bool	IsForceVisible () const

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

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

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

bool	HasCustomProperties () const

void	ClearCustomProperties ()

void	RemoveCustomProperty (const wxString &aKey)

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

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

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

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

virtual wxString	GetFriendlyName () const

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

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

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

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

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

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

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

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

virtual EMBEDDED_FILES *	GetEmbeddedFiles ()

bool	IsSCH_ITEM () const

bool	IsBOARD_ITEM () const

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

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

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

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

wxString	GetName () const

void	SetName (const wxString &aName)

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

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

bool	ContainsItem (const EDA_ITEM *aItem) const
	Test if an item is a direct or nested member of this group.

void	AddItem (EDA_ITEM *aItem)
	Add item to group.

void	RemoveItem (EDA_ITEM *aItem)
	Remove item from group.

void	RemoveAll ()

std::vector< KIID >	GetGroupMemberIds () const

bool	HasDesignBlockLink () const

void	SetDesignBlockLibId (const LIB_ID &aLibId)

const LIB_ID &	GetDesignBlockLibId () const

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

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

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

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

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

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

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

Public Attributes
const KIID	m_Uuid

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

Protected Member Functions
void	baseMirror (const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection)

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

void	swapData (BOARD_ITEM *aImage) override

void	swapChildOwnership (PCB_GROUP *aImage)
	Re-point the children of this group and aImage at whichever group now holds them.

EDA_ITEM *	findParent (KICAD_T aType) const

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

Protected Attributes
SHAPE_POLY_SET	m_outline

wxString	m_generatorType

VECTOR2I	m_origin

bool	m_isDirty

PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

BOARD *	m_boardCacheOwner = nullptr

EDA_ITEM_FLAGS	m_flags

EDA_ITEM *	m_parent
	Owner.

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

VECTOR2I	m_rolloverPos

bool	m_isRollover

bool	m_forceVisible

bool	m_netHighlighted = false

std::map< wxString, wxString >	m_customProperties

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

std::unordered_set< EDA_ITEM * >	m_items

wxString	m_name

LIB_ID	m_designBlockLibId

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

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

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

bool	m_isSCH_ITEM

bool	m_isBOARD_ITEM

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items.

Detailed Description

Definition at line 198 of file pcb_generator.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum BOARD_ITEM::COMPARE_FLAGS : int

inherited

Enumerator
DRC
INSTANCE_TO_INSTANCE

Definition at line 556 of file board_item.h.

Constructor & Destructor Documentation

◆ PCB_GENERATOR_POLY()

PCB_GENERATOR_POLY::PCB_GENERATOR_POLY	(	BOARD_ITEM *	aParent,
		PCB_LAYER_ID	aLayer )

inline

Definition at line 201 of file pcb_generator.h.

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

Referenced by PCB_VIA_STITCH::PCB_VIA_STITCH(), and PCB_VIA_STITCH::PCB_VIA_STITCH().

Member Function Documentation

◆ AddItem()

void EDA_GROUP::AddItem ( EDA_ITEM * aItem )

inherited

Add item to group.

Does not take ownership of item.

Definition at line 58 of file eda_group.cpp.

References AsEdaItem(), EDA_ITEM::GetParentGroup(), group, m_items, and EDA_ITEM::SetParentGroup().

◆ AsEdaItem()

EDA_ITEM * PCB_GROUP::AsEdaItem ( )

inlineoverridevirtualinherited

Implements EDA_GROUP.

Definition at line 59 of file pcb_group.h.

References EDA_ITEM::EDA_ITEM().

Referenced by PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), BOARD_NETLIST_UPDATER::updateFootprintGroup(), and BOARD_NETLIST_UPDATER::updateGroups().

◆ baseMirror()

void PCB_GENERATOR::baseMirror	(	const VECTOR2I &	aCentre,
		FLIP_DIRECTION	aFlipDirection )

protectedinherited

Definition at line 125 of file pcb_generator.cpp.

References m_origin, MIRROR(), TOP_BOTTOM, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_TUNING_PATTERN::baseMirror(), Flip(), and Mirror().

◆ BoardCopperLayerCount()

int BOARD_ITEM::BoardCopperLayerCount ( ) const

virtualinherited

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

Definition at line 203 of file board_item.cpp.

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

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

◆ BoardLayerCount()

int BOARD_ITEM::BoardLayerCount ( ) const

virtualinherited

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

Definition at line 192 of file board_item.cpp.

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

◆ BoardLayerSet()

LSET BOARD_ITEM::BoardLayerSet ( ) const

virtualinherited

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

Definition at line 214 of file board_item.cpp.

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

Referenced by ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper().

◆ CanDuplicate()

virtual bool PCB_GENERATOR::CanDuplicate ( ) const

inlinevirtualinherited

Reimplemented in PCB_VIA_STACK.

Definition at line 136 of file pcb_generator.h.

◆ ChildrenAreIndividuallySelectable()

virtual bool PCB_GENERATOR::ChildrenAreIndividuallySelectable ( ) const

inlinevirtualinherited

Returns: true if individual children of this generator can individually selected

Reimplemented in PCB_VIA_STITCH.

Definition at line 69 of file pcb_generator.h.

Referenced by EDIT_TOOL::doMoveSelection(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::Main(), PCB_SELECTION_TOOL::Selectable(), and PCB_SELECTION_TOOL::selectAllConnectedTracks().

◆ ChildrenAreReadOnly()

virtual bool PCB_GENERATOR::ChildrenAreReadOnly ( ) const

inlinevirtualinherited

Returns: true if children of this generator should be treated as read-only outside of the generator, i.e. disable property editors

Definition at line 83 of file pcb_generator.h.

Referenced by PCB_PROPERTIES_PANEL::filterOutReadOnlyGenChildren(), and EDIT_TOOL::Properties().

◆ ClassOf()

bool PCB_GENERATOR::ClassOf ( const EDA_ITEM * aItem )

inlinestaticinherited

Definition at line 190 of file pcb_generator.cpp.

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

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 154 of file eda_item.h.

References BRIGHTENED, and ClearFlags().

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

◆ ClearCustomProperties()

void EDA_ITEM::ClearCustomProperties ( )

inlineinherited

Definition at line 270 of file eda_item.h.

References m_customProperties.

◆ ClearDirty()

void PCB_GENERATOR::ClearDirty ( )

inlineinherited

Definition at line 170 of file pcb_generator.h.

References m_isDirty.

Referenced by PCB_VIA_STITCH::Update().

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 178 of file eda_item.h.

References ClearFlags(), and GetEditFlags().

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 160 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, m_flags, and m_netHighlighted.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 191 of file eda_item.h.

References ClearFlags(), and GetTempFlags().

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

◆ Clone()

EDA_ITEM * PCB_GROUP::Clone ( ) const

overridevirtualinherited

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.

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 211 of file pcb_group.cpp.

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

Referenced by PCB_GENERATOR::DeepClone().

◆ ContainsItem()

bool EDA_GROUP::ContainsItem ( const EDA_ITEM * aItem ) const

inherited

Test if an item is a direct or nested member of this group.

Definition at line 26 of file eda_group.cpp.

References group.

◆ CopyFrom()

void BOARD_ITEM::CopyFrom ( const BOARD_ITEM * aOther )

virtualinherited

Reimplemented in FOOTPRINT, PAD, PCB_ARC, PCB_CONSTRAINT, PCB_DIM_ALIGNED, PCB_DIM_CENTER, PCB_DIM_LEADER, PCB_DIM_ORTHOGONAL, PCB_DIM_RADIAL, PCB_FIELD, PCB_POINT, PCB_REFERENCE_IMAGE, PCB_SHAPE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 79 of file board_item.cpp.

References BOARD_ITEM().

Referenced by PCB_BARCODE::Clone(), PCB_TABLE::CopyFrom(), API_HANDLER_BOARD::handleCreateUpdateItemsInternal(), and API_HANDLER_PCB::handleGetVariants().

◆ DeepClone()

PCB_GENERATOR * PCB_GENERATOR::DeepClone ( ) const

inherited

Definition at line 42 of file pcb_generator.cpp.

References EDA_GROUP::AddItem(), BOARD_ITEM::BOARD_ITEM(), PCB_GROUP::Clone(), DeepClone(), EDA_ITEM::EDA_ITEM(), EDA_GROUP::m_items, PCB_GENERATOR(), PCB_GENERATOR_T, PCB_GROUP::PCB_GROUP(), and PCB_GROUP_T.

Referenced by BOOST_AUTO_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), and DeepClone().

◆ DeepDuplicate()

PCB_GROUP * PCB_GROUP::DeepDuplicate	(	bool	addToParentGroup,
		BOARD_COMMIT *	aCommit = nullptr,
		std::map< KIID, KIID > *	aKIIDMap = nullptr ) const

inherited

Definition at line 239 of file pcb_group.cpp.

References EDA_GROUP::AddItem(), BOARD_ITEM::BOARD_ITEM(), DeepDuplicate(), BOARD_ITEM::Duplicate(), EDA_ITEM::EDA_ITEM(), IGNORE_PARENT_GROUP, index, EDA_GROUP::m_items, EDA_ITEM::m_Uuid, PCB_GENERATOR_T, PCB_GROUP(), PCB_GROUP_T, RECURSE, and BOARD_ITEM::RunOnChildren().

Referenced by BOOST_AUTO_TEST_CASE(), and DeepDuplicate().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 303 of file board_item.cpp.

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

◆ Deserialize()

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

overridevirtualinherited

Deserializes the given protobuf message into this object.

Parameters

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

Returns: true if unpacking and deserialization succeeded

Reimplemented from SERIALIZABLE.

Definition at line 82 of file pcb_group.cpp.

References DeserializeGroup().

◆ DeserializeGroup()

bool PCB_GROUP::DeserializeGroup	(	const google::protobuf::Any &	aContainer,
		COMMIT *	aCommit )

overridevirtualinherited

Deserializes the given protobuf message into this group.

Groups may contain references to items in the current commit that are not yet present in the board or schematic. When necessary, items in the provided commit are used when populating the items contained in the group.

Parameters

aContainer	is a protobuf message to be unpacked and deserialized.
aCommit	is an active commit which may contain new items that belong in the group.

Returns: true if unpacking and deserialization succeeded.

Implements EDA_GROUP.

Definition at line 87 of file pcb_group.cpp.

References EDA_GROUP::AddItem(), BOARD_ITEM::BOARD, EDA_ITEM::EDA_ITEM(), BOARD_ITEM::GetBoard(), group, COMMIT::ResolveItem(), EDA_GROUP::SetDesignBlockLibId(), SetLocked(), EDA_GROUP::SetName(), BOARD_ITEM::SetUuidDirect(), kiapi::common::UnpackCustomProperties(), and kiapi::common::UnpackLibId().

Referenced by Deserialize().

◆ DisambiguateItemDescription()

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

inlinevirtualinherited

Reimplemented in FOOTPRINT.

Definition at line 456 of file eda_item.h.

References GetItemDescription().

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ Duplicate()

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

virtualinherited

Create a copy of this BOARD_ITEM.

Parameters

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

Reimplemented in FOOTPRINT, PCB_TABLE, and ZONE.

Definition at line 352 of file board_item.cpp.

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

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

◆ EditCancel()

virtual void PCB_GENERATOR::EditCancel	(	GENERATOR_TOOL *	aTool,
		BOARD *	aBoard,
		BOARD_COMMIT *	aCommit )

pure virtualinherited

Implemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

References BOARD_ITEM::BOARD.

Referenced by GENERATOR_TOOL::GenEditAction().

◆ EditFinish()

virtual void PCB_GENERATOR::EditFinish	(	GENERATOR_TOOL *	aTool,
		BOARD *	aBoard,
		BOARD_COMMIT *	aCommit )

pure virtualinherited

Implemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

References BOARD_ITEM::BOARD.

Referenced by GENERATOR_TOOL::GenEditAction(), and GENERATOR_TOOL::RegenerateItem().

◆ EditStart()

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

pure virtualinherited

Implemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

References BOARD_ITEM::BOARD.

Referenced by GENERATOR_TOOL::GenEditAction(), and GENERATOR_TOOL::RegenerateItem().

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 137 of file eda_item.cpp.

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

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

◆ FitsEnabledLayers()

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

virtualinherited

Check if a board offering aEnabledLayers can hold this item.

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

Reimplemented in FOOTPRINT, and PCB_VIA.

Definition at line 37 of file board_item.cpp.

References GetLayerSet(), and IsLayerAgnostic().

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

◆ Flip()

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

inlineoverridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters

aCentre	the rotation point.
aFlipDirection	the flip direction

Reimplemented from PCB_GENERATOR.

Definition at line 225 of file pcb_generator.h.

References PCB_GENERATOR::Flip(), m_outline, and PCB_GENERATOR::MarkDirty().

◆ Get() [1/3]

template<typename T>

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

inherited

Definition at line 84 of file inspectable_impl.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

◆ Get() [3/3]

template<typename T>

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

Definition at line 72 of file inspectable_impl.h.

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

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 95 of file board_item.cpp.

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

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 86 of file board_item.cpp.

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

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

◆ GetBoardItems()

std::unordered_set< BOARD_ITEM * > PCB_GROUP::GetBoardItems ( ) const

inherited

Definition at line 123 of file pcb_group.cpp.

References BOARD_ITEM::BOARD_ITEM(), EDA_ITEM::EDA_ITEM(), and EDA_GROUP::m_items.

◆ GetBoundingBox()

const BOX2I PCB_GENERATOR::GetBoundingBox ( ) const

overridevirtualinherited

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 88 of file pcb_generator.cpp.

◆ GetCenter()

virtual VECTOR2I BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

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

Returns: center point of the item

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

Definition at line 150 of file board_item.h.

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

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

◆ GetChildContextMenu()

virtual ACTION_MENU * PCB_GENERATOR::GetChildContextMenu ( TOOL_INTERACTIVE * aTool ) const

inlinevirtualinherited

Get a context menu when interacting with a generator child.

Returns: a non-owning ACTION_MENU* to display, or nullptr to fall through to the standard selection menu.

Reimplemented in PCB_VIA_STITCH.

Definition at line 77 of file pcb_generator.h.

Referenced by PCB_SELECTION_TOOL::Main().

◆ GetClass()

wxString PCB_GENERATOR::GetClass ( ) const

overridevirtualinherited

Return the class name.

Implements KIGFX::VIEW_ITEM.

Definition at line 184 of file pcb_generator.cpp.

◆ GetCommitMessage()

virtual wxString PCB_GENERATOR::GetCommitMessage ( ) const

pure virtualinherited

Implemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Referenced by PCB_POINT_EDITOR::OnSelectionChange(), and GENERATOR_TOOL::RegenerateItem().

◆ GetCustomProperties()

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

inlineinherited

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

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

Definition at line 242 of file eda_item.h.

References m_customProperties.

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

◆ GetCustomPropertiesAsInspectables()

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

inherited

Definition at line 200 of file eda_item.cpp.

References m_customProperties, m_dynamicCustomPropsCache, and TYPE_HASH.

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

◆ GetCustomProperty()

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

inherited

Returns: true if aKey is present and aValue was filled

Definition at line 188 of file eda_item.cpp.

References m_customProperties.

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

◆ GetDesignBlockLibId()

const LIB_ID & EDA_GROUP::GetDesignBlockLibId ( ) const

inlineinherited

Definition at line 88 of file eda_group.h.

References m_designBlockLibId.

Referenced by PCB_IO_KICAD_SEXPR::format(), SCH_IO_KICAD_SEXPR::saveGroup(), PCB_GROUP::Serialize(), and PCB_EDIT_FRAME::UpdateDesignBlockFromSelection().

◆ GetDynamicProperties()

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

overridevirtualinherited

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

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

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

Reimplemented from INSPECTABLE.

Reimplemented in FOOTPRINT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 226 of file eda_item.cpp.

References GetCustomPropertiesAsInspectables().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveHoleShape()

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

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 405 of file board_item.cpp.

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

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

◆ GetEffectiveShape()

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

overridevirtualinherited

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

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

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 365 of file pcb_group.cpp.

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

◆ GetEmbeddedFiles()

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )

inlinevirtualinherited

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

Definition at line 549 of file eda_item.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::Parse().

◆ GetEmbeddedFonts()

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

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 460 of file board_item.cpp.

References BOARD, and GetBoard().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 167 of file eda_item.h.

References m_flags.

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

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_ARC, PCB_SHAPE, and PCB_TRACK.

Definition at line 355 of file eda_item.h.

References GetPosition().

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

◆ GetFontMetrics()

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

inherited

Definition at line 169 of file board_item.cpp.

References KIFONT::METRICS::Default().

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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 167 of file view_item.h.

References m_forcedTransparency.

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

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 415 of file board_item.cpp.

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

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

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

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

Definition at line 565 of file eda_item.cpp.

References GetTypeDesc().

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

◆ GetGeneratorType()

wxString PCB_GENERATOR::GetGeneratorType ( ) const

virtualinherited

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 138 of file pcb_generator.cpp.

References m_generatorType.

Referenced by PCB_IO_KICAD_SEXPR::format().

◆ GetGroupMemberIds()

std::vector< KIID > EDA_GROUP::GetGroupMemberIds ( ) const

inherited

Definition at line 95 of file eda_group.cpp.

References m_items.

◆ GetItemDescription()

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

overridevirtualinherited

Return a user-visible description string of this item.

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

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

Parameters

aLong indicates a long string is acceptable

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 178 of file pcb_generator.cpp.

References _.

◆ GetItems() [1/2]

std::unordered_set< EDA_ITEM * > & EDA_GROUP::GetItems ( )

inlineinherited

Definition at line 64 of file eda_group.h.

References m_items.

◆ GetItems() [2/2]

const std::unordered_set< EDA_ITEM * > & EDA_GROUP::GetItems ( ) const

inlineinherited

Definition at line 65 of file eda_group.h.

References m_items.

◆ GetLayer()

PCB_LAYER_ID PCB_GENERATOR::GetLayer ( ) const

inlineoverridevirtualinherited

Return the primary layer this item is on.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TUNING_PATTERN.

Definition at line 129 of file pcb_generator.h.

References BOARD_ITEM::m_layer.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), DRC_TEST_PROVIDER_VIA_STACK::checkSpan(), Flip(), PCB_IO_KICAD_SEXPR::format(), PCB_TUNING_PATTERN::GetLayer(), GetLayerSet(), DRC_TEST_PROVIDER_VIA_STITCH::Run(), PCB_VIA_STACK::ShowPropertiesDialog(), and PCB_VIA_STACK::ViewGetLayers().

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

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

Returns: the layer name associated with this item.

Definition at line 225 of file board_item.cpp.

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

◆ GetLayerSet()

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 133 of file pcb_generator.cpp.

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

◆ GetMaxError()

int BOARD_ITEM::GetMaxError ( ) const

inherited

Definition at line 175 of file board_item.cpp.

References ARC_HIGH_DEF, BOARD, and GetBoard().

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

◆ GetMenuImage()

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

Reimplemented in PCB_TUNING_PATTERN.

Definition at line 484 of file pcb_group.cpp.

References module.

◆ GetMsgPanelInfo()

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

overridevirtualinherited

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.

Reimplemented in PCB_TUNING_PATTERN.

Definition at line 490 of file pcb_group.cpp.

References _, BOARD_ITEM::IsLocked(), EDA_GROUP::m_items, EDA_GROUP::m_name, and PCB_EDIT_FRAME_NAME.

◆ GetName()

wxString EDA_GROUP::GetName ( ) const

inlineinherited

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( ) const

inlineinherited

Definition at line 266 of file board_item.h.

References EDA_ITEM::m_parent.

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

◆ GetParentAsString()

wxString BOARD_ITEM::GetParentAsString ( ) const

inherited

For "parent" property.

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

Definition at line 451 of file board_item.cpp.

References EDA_ITEM::m_parent.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ GetParentFootprint()

FOOTPRINT * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 112 of file board_item.cpp.

References EDA_ITEM::findParent(), and PCB_FOOTPRINT_T.

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

◆ GetParentGroup()

virtual EDA_GROUP * EDA_ITEM::GetParentGroup ( ) const

inlinevirtualinherited

Reimplemented in PCB_TABLECELL, and SCH_TABLECELL.

Definition at line 116 of file eda_item.h.

References m_group.

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

◆ GetParentGroupId()

KIID EDA_ITEM::GetParentGroupId ( ) const

inherited

Definition at line 232 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

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

◆ GetPluralName()

virtual wxString PCB_GENERATOR::GetPluralName ( ) const

pure virtualinherited

Implemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

◆ GetPosition()

VECTOR2I PCB_GENERATOR::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in PCB_VIA_STITCH.

Definition at line 116 of file pcb_generator.h.

References m_origin.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_VIA_STACK::BuildMembers(), DRC_TEST_PROVIDER_VIA_STACK::checkSpan(), DRAWING_TOOL::PlaceMicroviaStack(), and PCB_VIA_STACK::ShowPropertiesDialog().

◆ GetPreviewItems()

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

virtualinherited

Reimplemented in PCB_TUNING_PATTERN.

Definition at line 62 of file pcb_generator.cpp.

◆ GetProperties()

const STRING_ANY_MAP PCB_GENERATOR::GetProperties ( ) const

virtualinherited

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 144 of file pcb_generator.cpp.

References m_origin, pcbIUScale, and STRING_ANY_MAP::set().

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_TUNING_PATTERN::GetProperties(), PCB_VIA_STACK::GetProperties(), and PCB_VIA_STITCH::GetProperties().

◆ GetRolloverPos()

VECTOR2I EDA_ITEM::GetRolloverPos ( ) const

inlineinherited

Definition at line 143 of file eda_item.h.

References m_rolloverPos.

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

◆ GetRowData()

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

virtualinherited

Reimplemented in PCB_TUNING_PATTERN.

Definition at line 168 of file pcb_generator.cpp.

References _HKI.

Referenced by PCB_TUNING_PATTERN::GetRowData().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

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

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

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 364 of file eda_item.h.

References GetPosition().

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 155 of file board_item.cpp.

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

Referenced by CONVERT_TOOL::CreatePolys().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 183 of file eda_item.h.

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

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

◆ GetTemplateItems()

virtual std::vector< std::pair< wxString, const BOARD_ITEM * > > PCB_GENERATOR::GetTemplateItems ( ) const

inlinevirtualinherited

Named template items used by the generator.

The via stitcher for example holds a single template via. These are real board items that are not attached to the board.

Returns: non-owning pointers to the template items; empty by default.

Reimplemented in PCB_VIA_STITCH.

Definition at line 92 of file pcb_generator.h.

Referenced by PCB_IO_KICAD_SEXPR::format().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

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

Definition at line 556 of file eda_item.cpp.

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

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

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 133 of file board_item.h.

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

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 139 of file board_item.h.

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

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

◆ GetZonesNeedingRefillAfterUpdate()

virtual std::vector< ZONE * > PCB_GENERATOR::GetZonesNeedingRefillAfterUpdate ( ) const

inlinevirtualinherited

Zones that need to be refilled after the generator runs Update()

Reimplemented in PCB_VIA_STITCH.

Definition at line 180 of file pcb_generator.h.

◆ HasCustomProperties()

bool EDA_ITEM::HasCustomProperties ( ) const

inlineinherited

Definition at line 269 of file eda_item.h.

References m_customProperties.

Referenced by KICAD_FORMAT::FormatCustomProperties().

◆ HasDesignBlockLink()

bool EDA_GROUP::HasDesignBlockLink ( ) const

inlineinherited

Definition at line 85 of file eda_group.h.

References m_designBlockLibId.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), PCB_IO_KICAD_SEXPR::format(), PCB_SELECTION_TOOL::Init(), SCH_IO_KICAD_SEXPR::saveGroup(), and PCB_GROUP::Serialize().

◆ HasDrilledHole()

virtual bool BOARD_ITEM::HasDrilledHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 212 of file board_item.h.

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

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 168 of file eda_item.h.

References m_flags.

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

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 207 of file board_item.h.

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

◆ HasLineStroke()

virtual bool BOARD_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this item has line stoke properties.

See also: STROKE_PARAMS

Reimplemented in PCB_SHAPE.

Definition at line 297 of file board_item.h.

Referenced by CONVERT_TOOL::CreatePolys().

◆ HasSelectedAncestorGroup()

bool EDA_ITEM::HasSelectedAncestorGroup ( ) const

inherited

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

Definition at line 241 of file eda_item.cpp.

References EDA_ITEM(), and group.

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

◆ HitTest() [1/3]

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

overridevirtualinherited

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TUNING_PATTERN, and PCB_VIA_STACK.

Definition at line 333 of file pcb_group.cpp.

◆ HitTest() [2/3]

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

overridevirtualinherited

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TUNING_PATTERN, and PCB_VIA_STACK.

Definition at line 340 of file pcb_group.cpp.

◆ HitTest() [3/3]

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

overridevirtualinherited

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 326 of file pcb_group.cpp.

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 98 of file view_item.h.

References m_isBOARD_ITEM.

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

References BRIGHTENED, m_flags, and m_netHighlighted.

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

Returns: True if the object is of BOARD_CONNECTED_ITEM type, false otherwise.

Reimplemented in BOARD_CONNECTED_ITEM, PCB_SHAPE, and ZONE.

Definition at line 172 of file board_item.h.

Referenced by PCB_CONTROL::ApplyDesignBlockLayout(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PNS::NODE::FindItemByParent(), BOARD_INSPECTION_TOOL::getItemDescription(), hasExactNetclassFunc(), hasNetChainFunc(), hasNetclassFunc(), inDiffPairFunc(), inNetChainClassFunc(), inNetChainFunc(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), ZONE_PAINTER::PCB_PAINTER(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testGraphicClearances(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances().

◆ IsDirty()

bool PCB_GENERATOR::IsDirty ( ) const

inlineinherited

Dirty flag system to for determining if generator output is not up to date It is up to each generator whether or not to actually use this flag.

Definition at line 168 of file pcb_generator.h.

References m_isDirty.

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 135 of file eda_item.h.

References ENTERED, and m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 233 of file eda_item.h.

References m_forceVisible.

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

◆ IsGroupableType()

bool BOARD_ITEM::IsGroupableType ( ) const

inherited

◆ IsIndexedInBoard()

bool BOARD_ITEM::IsIndexedInBoard ( ) const

inlineinherited

Definition at line 419 of file board_item.h.

References m_boardCacheOwner.

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Reimplemented in PCB_BARCODE.

Definition at line 413 of file board_item.h.

References m_isKnockout.

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

◆ IsLayerAgnostic()

bool PCB_GROUP::IsLayerAgnostic ( ) const

inlineoverridevirtualinherited

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

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

Reimplemented from BOARD_ITEM.

Definition at line 112 of file pcb_group.h.

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 140 of file board_item.cpp.

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 130 of file eda_item.h.

References IS_CHANGED, and m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ IsNetHighlighted()

bool EDA_ITEM::IsNetHighlighted ( ) const

inherited

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

Definition at line 125 of file eda_item.cpp.

References m_netHighlighted.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References IS_NEW, and m_flags.

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

◆ IsOnCopperLayer()

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 120 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 404 of file pcb_group.cpp.

References BOARD_ITEM::BOARD_ITEM(), EDA_ITEM::EDA_ITEM(), IsOnLayer(), and EDA_GROUP::m_items.

Referenced by IsOnLayer().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 520 of file eda_item.h.

Referenced by Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References m_isRollover.

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

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 97 of file view_item.h.

References m_isSCH_ITEM.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 134 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsSideSpecific()

bool BOARD_ITEM::IsSideSpecific ( ) const

inherited

Definition at line 235 of file board_item.cpp.

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

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

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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

Parameters

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

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

Reimplemented in PCB_VIA.

Definition at line 224 of file board_item.h.

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

◆ IsType()

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

inlinevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Reimplemented in PAD, PCB_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_VIA, SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, and SCH_LINE.

Definition at line 214 of file eda_item.h.

References m_structType, and SCH_LOCATE_ANY_T.

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

◆ IterateForward() [1/2]

template<class T>

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

inlinestaticinherited

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

Definition at line 401 of file eda_item.h.

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

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

◆ IterateForward() [2/2]

template<class T>

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

inlinestaticinherited

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

Definition at line 421 of file eda_item.h.

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

◆ LayerFollowsMembers()

virtual bool PCB_GENERATOR::LayerFollowsMembers ( ) const

inlinevirtualinherited

Reimplemented in PCB_VIA_STACK.

Definition at line 134 of file pcb_generator.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::resolveGroups().

◆ LayerMaskDescribe()

wxString BOARD_ITEM::LayerMaskDescribe ( ) const

virtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 252 of file board_item.cpp.

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

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

◆ lodScaleForThreshold()

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

staticprotectedinherited

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

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

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

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

Definition at line 35 of file view_item.cpp.

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

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

◆ MakeEditPoints()

bool PCB_GENERATOR::MakeEditPoints ( EDIT_POINTS & aEditPoints ) const

virtualinherited

Reimplemented in PCB_TUNING_PATTERN.

Definition at line 70 of file pcb_generator.cpp.

◆ MarkDirty()

void PCB_GENERATOR::MarkDirty ( )

inlineinherited

◆ Matches() [1/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 318 of file eda_item.cpp.

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

◆ Matches() [2/2]

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

overridevirtualinherited

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. Invoke a function on all children.

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

Reimplemented from EDA_ITEM.

Definition at line 500 of file pcb_group.cpp.

References EDA_GROUP::GetName(), EDA_ITEM::Matches(), and UnescapeString().

◆ Mirror()

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

inlineoverridevirtual

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

Parameters

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

Reimplemented from PCB_GENERATOR.

Definition at line 232 of file pcb_generator.h.

References m_outline, PCB_GENERATOR::MarkDirty(), and PCB_GENERATOR::Mirror().

◆ Move()

void PCB_GENERATOR_POLY::Move ( const VECTOR2I & aMoveVector )

inlineoverridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from PCB_GENERATOR.

Reimplemented in PCB_VIA_STITCH.

Definition at line 211 of file pcb_generator.h.

References m_outline, PCB_GENERATOR::MarkDirty(), and PCB_GENERATOR::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 487 of file board_item.h.

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

◆ NormalizeForCompare()

virtual void BOARD_ITEM::NormalizeForCompare ( )

inlinevirtualinherited

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

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

Reimplemented in PCB_SHAPE.

Definition at line 494 of file board_item.h.

References Normalize().

◆ OnFootprintRescaled()

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

inlinevirtualinherited

Apply a parent footprint scale to this item.

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

Parameters

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

Reimplemented in PAD, PCB_BARCODE, PCB_DIMENSION_BASE, PCB_SHAPE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 458 of file board_item.h.

◆ OnFootprintTransformed()

virtual void BOARD_ITEM::OnFootprintTransformed ( )

inlinevirtualinherited

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

Scaling uses OnFootprintRescaled.

Reimplemented in PAD, PCB_DIMENSION_BASE, PCB_POINT, PCB_SHAPE, PCB_TABLE, PCB_TEXT, PCB_TEXTBOX, and ZONE.

Definition at line 466 of file board_item.h.

◆ OnZoneFillChanged()

virtual void PCB_GENERATOR::OnZoneFillChanged ( const std::vector< ZONE * > & aZones )

inlinevirtualinherited

Callback to be informed zones have changed.

Reimplemented in PCB_VIA_STITCH.

Definition at line 175 of file pcb_generator.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 479 of file eda_item.cpp.

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

◆ operator==() [1/2]

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

overridevirtualinherited

Implements BOARD_ITEM.

Definition at line 527 of file pcb_group.cpp.

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

◆ operator==() [2/2]

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

inherited

Definition at line 538 of file pcb_group.cpp.

References EDA_GROUP::m_items, and PCB_GROUP().

◆ Outline() [1/2]

SHAPE_POLY_SET & PCB_GENERATOR_POLY::Outline ( )

inline

Definition at line 207 of file pcb_generator.h.

References m_outline.

◆ Outline() [2/2]

const SHAPE_POLY_SET & PCB_GENERATOR_POLY::Outline ( ) const

inline

Definition at line 206 of file pcb_generator.h.

References m_outline.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and DRC_TEST_PROVIDER_VIA_STITCH::Run().

◆ RemapKIIDs()

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

inlinevirtualinherited

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

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

Reimplemented in PCB_CONSTRAINT.

Definition at line 287 of file board_item.h.

Referenced by PCB_CONTROL::placeBoardItems().

◆ Remove()

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

pure virtualinherited

Implemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

References BOARD_ITEM::BOARD.

Referenced by GENERATOR_TOOL::GenEditAction().

◆ RemoveAll()

void EDA_GROUP::RemoveAll ( )

inherited

Definition at line 86 of file eda_group.cpp.

References m_items.

Referenced by PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), SCH_EDIT_FRAME::UpdateDesignBlockFromSelection(), and BOARD_NETLIST_UPDATER::updateFootprintGroup().

◆ RemoveConflictingCustomProperties()

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

inherited

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

Returns the keys removed, if any.

Definition at line 168 of file eda_item.cpp.

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

◆ RemoveCustomProperty()

void EDA_ITEM::RemoveCustomProperty ( const wxString & aKey )

inherited

Definition at line 161 of file eda_item.cpp.

References m_customProperties, and m_dynamicCustomPropsCache.

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

◆ RemoveItem()

void EDA_GROUP::RemoveItem ( EDA_ITEM * aItem )

inherited

Remove item from group.

Definition at line 77 of file eda_group.cpp.

References m_items, and EDA_ITEM::SetParentGroup().

Referenced by BOARD::ExchangeFootprint(), PCB_CONTROL::Paste(), BOARD_COMMIT::Push(), PCB_VIA_STACK::Regenerate(), PCB_VIA_STITCH::Update(), and BOARD_NETLIST_UPDATER::updateFootprintGroup().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 196 of file eda_item.h.

◆ Replace() [1/2]

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

inlinevirtualinherited

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

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

Parameters

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

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

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

Definition at line 509 of file eda_item.h.

◆ Replace() [2/2]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 396 of file eda_item.cpp.

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

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

◆ ResetUuid()

void BOARD_ITEM::ResetUuid ( )

inlineinherited

Definition at line 280 of file board_item.h.

References SetUuid().

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

◆ ResetUuidDirect()

void BOARD_ITEM::ResetUuidDirect ( )

inlineinherited

Definition at line 277 of file board_item.h.

References SetUuidDirect().

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

◆ Rotate()

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

inlineoverridevirtual

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from PCB_GENERATOR.

Definition at line 218 of file pcb_generator.h.

References m_outline, PCB_GENERATOR::MarkDirty(), and PCB_GENERATOR::Rotate().

◆ RunOnChildren()

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

overridevirtualinherited

Invoke a function on all children.

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

Reimplemented from BOARD_ITEM.

Definition at line 506 of file pcb_group.cpp.

References BOARD_ITEM::BOARD_ITEM(), GetBoardItems(), PCB_GENERATOR_T, PCB_GROUP_T, and RECURSE.

Referenced by BOOST_AUTO_TEST_CASE(), MULTICHANNEL_TOOL::copyRuleAreaContents(), groupMirrorable(), Mirror(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), SetLocked(), and swapChildOwnership().

◆ Serialize()

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

overridevirtualinherited

Serializes this object to the given Any message.

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

Parameters

aContainer will be filled with a message describing this object

Reimplemented from SERIALIZABLE.

Definition at line 54 of file pcb_group.cpp.

References BOARD_ITEM::BOARD, EDA_ITEM::EDA_ITEM(), BOARD_ITEM::GetBoard(), EDA_GROUP::GetDesignBlockLibId(), EDA_GROUP::GetItems(), EDA_GROUP::GetName(), BOARD_ITEM::GetParentFootprint(), group, EDA_GROUP::HasDesignBlockLink(), BOARD_ITEM::IsLocked(), EDA_ITEM::m_Uuid, kiapi::common::PackCustomProperties(), and kiapi::common::PackLibId().

◆ Set() [1/4]

template<typename T>

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

inherited

Definition at line 48 of file inspectable_impl.h.

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

◆ Set() [2/4]

template<typename T>

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

inherited

Definition at line 31 of file inspectable_impl.h.

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

◆ Set() [3/4]

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

inherited

Definition at line 28 of file inspectable.cpp.

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

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

◆ Set() [4/4]

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

inherited

Definition at line 45 of file inspectable.cpp.

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

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 151 of file eda_item.h.

References BRIGHTENED, and SetFlags().

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

◆ SetCustomProperties()

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

inlineinherited

Definition at line 247 of file eda_item.h.

References m_customProperties, and SetCustomProperty().

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

◆ SetCustomProperty()

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

inlineinherited

Definition at line 255 of file eda_item.h.

References m_customProperties.

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

◆ SetDesignBlockLibId()

void EDA_GROUP::SetDesignBlockLibId ( const LIB_ID & aLibId )

inlineinherited

Definition at line 87 of file eda_group.h.

References m_designBlockLibId.

Referenced by PCB_GROUP::DeserializeGroup(), SCH_DRAWING_TOOLS::DrawSheet(), PCB_EDIT_FRAME::SaveSelectionAsDesignBlock(), SCH_EDIT_FRAME::SaveSelectionAsDesignBlock(), PCB_EDIT_FRAME::UpdateDesignBlockFromSelection(), and SCH_EDIT_FRAME::UpdateDesignBlockFromSelection().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 158 of file eda_item.h.

References m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 162 of file view_item.h.

References m_forcedTransparency.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 232 of file eda_item.h.

References m_forceVisible.

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

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 424 of file board_item.cpp.

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

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

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

◆ SetIsRollover()

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

inlineinherited

Definition at line 144 of file eda_item.h.

References m_isRollover, and m_rolloverPos.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 198 of file eda_item.h.

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

◆ SetLayer()

void PCB_GENERATOR::SetLayer ( PCB_LAYER_ID aLayer )

inlineoverridevirtualinherited

Set the layer this item is on.

Parameters

aLayer The layer number.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TUNING_PATTERN.

Definition at line 130 of file pcb_generator.h.

References BOARD_ITEM::m_layer.

Referenced by Flip(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), PCB_TUNING_PATTERN::SetLayer(), and PCB_VIA_STACK::SetStartLayer().

◆ SetLayerSet()

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

inlinevirtualinherited

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

Definition at line 354 of file board_item.h.

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

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

◆ SetLocked()

void PCB_GROUP::SetLocked ( bool aLocked )

overridevirtualinherited

Reimplemented from BOARD_ITEM.

Definition at line 198 of file pcb_group.cpp.

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

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

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 260 of file eda_item.cpp.

References IS_CHANGED, m_parent, and SetFlags().

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

◆ SetName()

void EDA_GROUP::SetName ( const wxString & aName )

inlineinherited

Definition at line 62 of file eda_group.h.

References m_name.

◆ SetNetHighlighted()

void EDA_ITEM::SetNetHighlighted ( bool aHighlighted )

inherited

Definition at line 131 of file eda_item.cpp.

References m_netHighlighted.

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

◆ SetOutline()

void PCB_GENERATOR_POLY::SetOutline ( const SHAPE_POLY_SET & aOutline )

inline

Definition at line 209 of file pcb_generator.h.

References m_outline, and PCB_GENERATOR::MarkDirty().

Referenced by configureStitch().

◆ SetParent()

void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

virtualinherited

Reimplemented in LIB_SYMBOL, NETINFO_ITEM, and PCB_POINT.

Definition at line 153 of file eda_item.cpp.

References EDA_ITEM(), and m_parent.

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

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

Definition at line 115 of file eda_item.h.

References m_group.

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

◆ SetPosition()

void PCB_GENERATOR::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 117 of file pcb_generator.h.

References m_origin.

◆ SetProperties()

void PCB_GENERATOR::SetProperties ( const STRING_ANY_MAP & aProps )

virtualinherited

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 158 of file pcb_generator.cpp.

References STRING_ANY_MAP::get_to(), and m_origin.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), PCB_TUNING_PATTERN::SetProperties(), PCB_VIA_STACK::SetProperties(), and PCB_VIA_STITCH::SetProperties().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 150 of file eda_item.h.

References SELECTED, and SetFlags().

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

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 163 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass().

◆ SetTemplateItem()

virtual void PCB_GENERATOR::SetTemplateItem	(	const wxString &	aName,
		std::unique_ptr< BOARD_ITEM >	aItem )

inlinevirtualinherited

Insert a template item (from board file loading)

Parameters

aName	Template name
aItem	The parsed item

Reimplemented in PCB_VIA_STITCH.

Definition at line 100 of file pcb_generator.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::resolveGroups().

◆ SetUuid()

void BOARD_ITEM::SetUuid ( const KIID & aUuid )

inherited

Definition at line 118 of file board_item.cpp.

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

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

◆ SetUuidDirect()

void BOARD_ITEM::SetUuidDirect ( const KIID & aUuid )

inherited

Raw UUID assignment.

No board index maintenance.

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

Definition at line 134 of file board_item.cpp.

References EDA_ITEM::m_Uuid.

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 155 of file board_item.h.

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

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

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 161 of file board_item.h.

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

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

◆ ShowPropertiesDialog()

virtual void PCB_GENERATOR::ShowPropertiesDialog ( PCB_BASE_EDIT_FRAME * aEditFrame )

inlinevirtualinherited

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 144 of file pcb_generator.h.

◆ 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 560 of file pcb_group.cpp.

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

Referenced by 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 538 of file eda_item.h.

References EDA_ITEM().

◆ StyleFromSettings()

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

inlinevirtualinherited

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

Definition at line 423 of file board_item.h.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ swapChildOwnership()

void PCB_GROUP::swapChildOwnership ( PCB_GROUP * aImage )

protectedinherited

Re-point the children of this group and aImage at whichever group now holds them.

swapData() exchanges the member set with the undo image, but the children's parentGroup back-pointers are not part of that swap and are left naming the wrong group. Subclasses that swap their own derived data must call this afterwards.

Definition at line 303 of file pcb_group.cpp.

References BOARD_ITEM::BOARD_ITEM(), NO_RECURSE, PCB_GROUP(), RunOnChildren(), and EDA_ITEM::SetParentGroup().

Referenced by swapData(), and PCB_VIA_STACK::swapData().

◆ swapData()

void PCB_GROUP::swapData ( BOARD_ITEM * aImage )

overrideprotectedvirtualinherited

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 292 of file pcb_group.cpp.

References BOARD_ITEM::BOARD_ITEM(), image, PCB_GROUP(), PCB_GROUP_T, swapChildOwnership(), and EDA_ITEM::Type().

◆ SwapItemData()

void BOARD_ITEM::SwapItemData ( BOARD_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

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

Parameters

aImage the item image which contains data to swap.

Definition at line 320 of file board_item.cpp.

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

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

◆ TopLevelGroup()

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

staticinherited

Definition at line 165 of file pcb_group.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and 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 polygonal shape (inflated polygon).
aError	the maximum deviation from true circle.
aErrorLoc	should the approximation error be placed outside or inside the polygon?
ignoreLineWidth	used for edge cut items where the line width is only for visualization.

Reimplemented in PAD, PCB_BARCODE, PCB_DIMENSION_BASE, PCB_GRID_ITEM, PCB_MARKER, PCB_POINT, PCB_SHAPE, PCB_TABLE, PCB_TARGET, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, and ZONE.

Definition at line 372 of file board_item.cpp.

References KIGFX::VIEW_ITEM::GetClass().

Referenced by addItemPolysWithEndings(), addItemPolysWithEndings(), addItemPolysWithEndings(), ZONE_FILLER::addKnockout(), ZONE_FILLER::addKnockout(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkReturnPath(), FOOTPRINT::CoverageRatio(), enclosedByAreaFunc(), FOOTPRINT::GetCoverageArea(), process(), PNS_KICAD_IFACE_BASE::syncTextItem(), and TransformShapeToPolySet().

◆ TransformShapeToPolySet()

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

inlinevirtualinherited

Convert the item shape to a polyset.

Circles and arcs are approximated by segments; hatched fills and details (if any) will be included.

Parameters

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

Reimplemented in PCB_SHAPE, and PCB_TABLE.

Definition at line 542 of file board_item.h.

References TransformShapeToPolygon().

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

◆ Type()

KICAD_T EDA_ITEM::Type ( ) const

inlineinherited

Returns the type of object.

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

Returns: the type of object.

Definition at line 110 of file eda_item.h.

References m_structType.

◆ Update()

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

pure virtualinherited

Implemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

References BOARD_ITEM::BOARD.

Referenced by GENERATOR_TOOL::GenEditAction(), and GENERATOR_TOOL::RegenerateItem().

◆ UpdateEditPoints()

bool PCB_GENERATOR::UpdateEditPoints ( EDIT_POINTS & aEditPoints )

virtualinherited

Reimplemented in PCB_TUNING_PATTERN.

Definition at line 82 of file pcb_generator.cpp.

◆ UpdateFromEditPoints()

bool PCB_GENERATOR::UpdateFromEditPoints ( EDIT_POINTS & aEditPoints )

virtualinherited

Reimplemented in PCB_TUNING_PATTERN.

Definition at line 76 of file pcb_generator.cpp.

◆ ViewBBox()

const BOX2I EDA_ITEM::ViewBBox ( ) const

overridevirtualinherited

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

Returns: the current bounding box.

Implements KIGFX::VIEW_ITEM.

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

Definition at line 509 of file eda_item.cpp.

References GetBoundingBox().

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

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

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

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

Definition at line 123 of file view_item.h.

References VIEW.

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

◆ ViewGetLayers()

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

overridevirtualinherited

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TUNING_PATTERN, PCB_VIA_STACK, and PCB_VIA_STITCH.

Definition at line 417 of file pcb_group.cpp.

References LAYER_ANCHOR.

◆ ViewGetLOD()

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

overridevirtualinherited

Reimplemented from KIGFX::VIEW_ITEM.

Definition at line 423 of file pcb_group.cpp.

References KIGFX::VIEW::IsLayerVisibleCached(), LAYER_ANCHOR, KIGFX::VIEW_ITEM::LOD_HIDE, and KIGFX::VIEW_ITEM::LOD_SHOW.

◆ 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 377 of file pcb_group.cpp.

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

◆ WithinScope()

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

staticinherited

Definition at line 171 of file pcb_group.cpp.

References EDA_GROUP::AsEdaItem(), BOARD_ITEM::BOARD_ITEM(), getClosestGroup(), getNestedGroup(), EDA_ITEM::GetParentGroup(), group, and PCB_GROUP().

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

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 159 of file eda_item.h.

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

Member Data Documentation

◆ LOD_HIDE

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

staticconstexprprotectedinherited

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

Definition at line 176 of file view_item.h.

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

◆ LOD_SHOW

double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

staticconstexprprotectedinherited

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

Definition at line 181 of file view_item.h.

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

◆ m_boardCacheOwner

BOARD* BOARD_ITEM::m_boardCacheOwner = nullptr

mutableprotectedinherited

Definition at line 576 of file board_item.h.

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

◆ m_customProperties

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

protectedinherited

Definition at line 615 of file eda_item.h.

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

◆ m_designBlockLibId

LIB_ID EDA_GROUP::m_designBlockLibId

protectedinherited

Definition at line 93 of file eda_group.h.

Referenced by GetDesignBlockLibId(), HasDesignBlockLink(), SetDesignBlockLibId(), and SCH_GROUP::swapData().

◆ m_dynamicCustomPropsCache

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

mutableprotectedinherited

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

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

Definition at line 621 of file eda_item.h.

Referenced by GetCustomPropertiesAsInspectables(), and RemoveCustomProperty().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 606 of file eda_item.h.

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

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 206 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 612 of file eda_item.h.

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

◆ m_generatorType

wxString PCB_GENERATOR::m_generatorType

protectedinherited

Definition at line 183 of file pcb_generator.h.

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

◆ m_group

EDA_GROUP* EDA_ITEM::m_group

protectedinherited

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

Definition at line 608 of file eda_item.h.

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

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 204 of file view_item.h.

Referenced by IsBOARD_ITEM(), and VIEW_ITEM().

◆ m_isDirty

bool PCB_GENERATOR::m_isDirty

protectedinherited

Definition at line 187 of file pcb_generator.h.

Referenced by ClearDirty(), IsDirty(), MarkDirty(), and PCB_GENERATOR().

◆ m_isKnockout

bool BOARD_ITEM::m_isKnockout

protectedinherited

Definition at line 572 of file board_item.h.

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

◆ m_isLocked

bool BOARD_ITEM::m_isLocked

protectedinherited

Definition at line 573 of file board_item.h.

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

◆ m_isRollover

bool EDA_ITEM::m_isRollover

protectedinherited

Definition at line 611 of file eda_item.h.

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

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 203 of file view_item.h.

Referenced by IsSCH_ITEM(), and VIEW_ITEM().

◆ m_items

std::unordered_set<EDA_ITEM*> EDA_GROUP::m_items

protectedinherited

Definition at line 91 of file eda_group.h.

Referenced by AddItem(), PCB_GENERATOR::DeepClone(), PCB_GROUP::DeepClone(), SCH_GROUP::DeepClone(), PCB_GROUP::DeepDuplicate(), SCH_GROUP::DeepDuplicate(), SCH_GROUP::DeserializeGroup(), PCB_GROUP::Flip(), PCB_GROUP::GetBoardItems(), PCB_GROUP::GetBoundingBox(), PCB_TUNING_PATTERN::GetBoundingBox(), SCH_GROUP::GetBoundingBox(), GetGroupMemberIds(), PCB_GROUP::GetItemDescription(), SCH_GROUP::GetItemDescription(), GetItems(), GetItems(), PCB_GROUP::GetLayerSet(), PCB_GROUP::GetMsgPanelInfo(), SCH_GROUP::GetMsgPanelInfo(), SCH_GROUP::GetSchItems(), PCB_GROUP::IsOnLayer(), PCB_GROUP::Mirror(), SCH_GROUP::MirrorHorizontally(), SCH_GROUP::MirrorVertically(), PCB_GROUP::Move(), SCH_GROUP::Move(), PCB_GROUP::operator==(), SCH_GROUP::operator==(), RemoveAll(), RemoveItem(), PCB_GROUP::Rotate(), SCH_GROUP::Rotate(), SCH_GROUP::RunOnChildren(), SCH_GROUP::Serialize(), PCB_TUNING_PATTERN::ShowPropertiesDialog(), PCB_GROUP::Similarity(), SCH_GROUP::Similarity(), and SCH_GROUP::swapData().

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 571 of file board_item.h.

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

◆ m_name

wxString EDA_GROUP::m_name

protectedinherited

Definition at line 92 of file eda_group.h.

Referenced by PCB_GROUP::GetItemDescription(), SCH_GROUP::GetItemDescription(), PCB_GROUP::GetMsgPanelInfo(), SCH_GROUP::GetMsgPanelInfo(), GetName(), PCB_TUNING_PATTERN::PCB_TUNING_PATTERN(), PCB_VIA_STACK::PCB_VIA_STACK(), PCB_VIA_STITCH::PCB_VIA_STITCH(), SetName(), and SCH_GROUP::swapData().

◆ m_netHighlighted

bool EDA_ITEM::m_netHighlighted = false

protectedinherited

Definition at line 613 of file eda_item.h.

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

◆ m_origin

VECTOR2I PCB_GENERATOR::m_origin

protectedinherited

◆ m_outline

SHAPE_POLY_SET PCB_GENERATOR_POLY::m_outline

protected

Definition at line 240 of file pcb_generator.h.

Referenced by PCB_VIA_STITCH::buildPlacementCells(), Flip(), PCB_VIA_STITCH::GetBoundingBox(), PCB_VIA_STITCH::GetPosition(), PCB_VIA_STITCH::GetProperties(), PCB_VIA_STITCH::HitTest(), Mirror(), Move(), PCB_VIA_STITCH::Move(), Outline(), Outline(), Rotate(), SetOutline(), PCB_VIA_STITCH::SetProperties(), PCB_VIA_STITCH::Update(), and PCB_VIA_STITCH::ViewDraw().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Owner.

Definition at line 607 of file eda_item.h.

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

◆ m_rolloverPos

VECTOR2I EDA_ITEM::m_rolloverPos

protectedinherited

Definition at line 610 of file eda_item.h.

Referenced by GetRolloverPos(), and SetIsRollover().

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

Definition at line 603 of file eda_item.h.

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

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 597 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 205 of file view_item.h.

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

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

Definition at line 232 of file board_item.h.

Referenced by BOARD::GetPosition().

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

pcb_generator.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

Constructor & Destructor Documentation

◆ PCB_GENERATOR_POLY()

Member Function Documentation

◆ AddItem()

◆ AsEdaItem()

◆ baseMirror()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ CanDuplicate()

◆ ChildrenAreIndividuallySelectable()

◆ ChildrenAreReadOnly()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearCustomProperties()

◆ ClearDirty()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ ContainsItem()

◆ CopyFrom()

◆ DeepClone()

◆ DeepDuplicate()

◆ DeleteStructure()

◆ Deserialize()

◆ DeserializeGroup()

◆ DisambiguateItemDescription()

◆ Duplicate()

◆ EditCancel()

◆ EditFinish()

◆ EditStart()

◆ findParent()

◆ FitsEnabledLayers()

◆ Flip()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoardItems()

◆ GetBoundingBox()

◆ GetCenter()

◆ GetChildContextMenu()

◆ GetClass()

◆ GetCommitMessage()

◆ GetCustomProperties()

◆ GetCustomPropertiesAsInspectables()

◆ GetCustomProperty()

◆ GetDesignBlockLibId()

◆ GetDynamicProperties()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveShape()

◆ GetEmbeddedFiles()

◆ GetEmbeddedFonts()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFontMetrics()

◆ GetForcedTransparency()

◆ GetFPRelativePosition()

◆ GetFriendlyName()

◆ GetGeneratorType()

◆ GetGroupMemberIds()

◆ GetItemDescription()

◆ GetItems() [1/2]