#include <pcb_shape.h>

Inheritance diagram for PCB_SHAPE:

Classes
struct	cmp_drawings

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

Public Member Functions
	PCB_SHAPE (BOARD_ITEM *aParent, KICAD_T aItemType, SHAPE_T aShapeType)

	PCB_SHAPE (BOARD_ITEM *aParent=nullptr, SHAPE_T aShapeType=SHAPE_T::SEGMENT)

	~PCB_SHAPE () override

void	CopyFrom (const BOARD_ITEM *aOther) override

wxString	GetClass () const override
	Return the class name.

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	IsConnected () const override
	Returns information if the object is derived from BOARD_CONNECTED_ITEM.

wxString	GetFriendlyName () const override

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

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

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

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

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

virtual void	SetLayerSet (const LSET &aLayers) override

void	SetPosition (const VECTOR2I &aPos) override

VECTOR2I	GetPosition () const override

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

std::vector< VECTOR2I >	GetConnectionPoints () const

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

STROKE_PARAMS	GetStroke () const override

void	SetStroke (const STROKE_PARAMS &aStroke) override

int	GetWidth () const override

void	StyleFromSettings (const BOARD_DESIGN_SETTINGS &settings) override

virtual std::vector< VECTOR2I >	GetCorners () const
	Return 4 corners for a rectangle or rotated rectangle (stored as a poly).

const VECTOR2I	GetFocusPosition () const override
	Allows items to return their visual center rather than their anchor.

std::shared_ptr< SHAPE >	GetEffectiveShape (PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
	Make a set of SHAPE objects representing the PCB_SHAPE.

bool	IsProxyItem () const override

void	SetIsProxyItem (bool aIsProxy=true) override

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

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

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

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

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

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

void	NormalizeForCompare () override
	Normalize coordinates to compare 2 similar PCB_SHAPES similat to Normalize(), but also normalize SEGMENT end points needed only for graphic comparisons.

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.

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

void	Scale (double aScale)

void	UpdateHatching () const override

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

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

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

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

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

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

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

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

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

bool	operator== (const PCB_SHAPE &aShape) const

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

void	SetHasSolderMask (bool aVal)

bool	HasSolderMask () const

void	SetLocalSolderMaskMargin (std::optional< int > aMargin)

std::optional< int >	GetLocalSolderMaskMargin () const

int	GetSolderMaskExpansion () const

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

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

void	UnpackNet (const kiapi::board::types::Net &aProto)
	Assigns a net to this item from an API message.

void	PackNet (kiapi::board::types::Net *aProto) const

int	GetNetCode () const

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

void	SetNetCode (int aNetCode)

wxString	GetNetname () const

wxString	GetNetnameMsg () const

const wxString &	GetShortNetname () const

const wxString &	GetDisplayNetname () const

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

virtual std::optional< int >	GetClearanceOverrides (wxString *aSource) const
	Return any clearance overrides set in the "classic" (ie: pre-rule) system.

virtual std::optional< int >	GetLocalClearance () const
	Return any local clearances set in the "classic" (ie: pre-rule) system.

virtual std::optional< int >	GetLocalClearance (wxString *aSource) const
	Return any local clearances set in the "classic" (ie: pre-rule) system.

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

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

void	SetLocalRatsnestVisible (bool aVisible)

bool	GetLocalRatsnestVisible () const

TEARDROP_PARAMETERS &	GetTeardropParams ()

const TEARDROP_PARAMETERS &	GetTeardropParams () const

void	SetTeardropsEnabled (bool aEnable)

bool	GetTeardropsEnabled () const

void	SetTeardropBestLengthRatio (double aRatio)

double	GetTeardropBestLengthRatio () const

void	SetTeardropMaxLength (int aMaxLength)

int	GetTeardropMaxLength () const

void	SetTeardropBestWidthRatio (double aRatio)

double	GetTeardropBestWidthRatio () const

void	SetTeardropMaxWidth (int aMaxWidth)

int	GetTeardropMaxWidth () const

void	SetTeardropCurved (bool aCurve)

bool	GetTeardropCurved () const

void	SetTeardropPreferZoneConnections (bool aPrefer)

bool	GetTeardropPreferZoneConnections () const

void	SetTeardropAllowSpanTwoTracks (bool aAllow)

bool	GetTeardropAllowSpanTwoTracks () const

void	SetTeardropMaxTrackWidth (double aRatio)

double	GetTeardropMaxTrackWidth () const

bool	IsGroupableType () const

int	GetX () const

int	GetY () const

void	SetX (int aX)

void	SetY (int aY)

virtual bool	IsOnCopperLayer () const

virtual bool	HasHole () const

virtual bool	HasDrilledHole () const

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

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

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

BOARD_ITEM_CONTAINER *	GetParent () const

FOOTPRINT *	GetParentFootprint () const

VECTOR2I	GetFPRelativePosition () const

void	SetFPRelativePosition (const VECTOR2I &aPos)

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.

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

void	SetLocked (bool aLocked) override

int	GetMaxError () const

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

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.

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

KICAD_T	Type () const
	Returns the type of object.

virtual void	SetParent (EDA_ITEM *aParent)

virtual void	SetParentGroup (EDA_GROUP *aGroup)

virtual EDA_GROUP *	GetParentGroup () const

KIID	GetParentGroupId () const

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetIsRollover (bool aIsRollover)

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

virtual void	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

virtual void	ClearTempFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

bool	IsForceVisible () const

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

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

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

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

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

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

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

virtual EMBEDDED_FILES *	GetEmbeddedFiles ()

bool	IsSCH_ITEM () const

bool	IsBOARD_ITEM () const

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

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

void	SwapShape (EDA_SHAPE *aImage)

wxString	ShowShape () const

wxString	SHAPE_T_asString () const

bool	IsAnyFill () const

bool	IsSolidFill () const

bool	IsHatchedFill () const

virtual bool	IsFilledForHitTesting () const

virtual void	SetFilled (bool aFlag)

void	SetFillMode (FILL_T aFill)

FILL_T	GetFillMode () const

void	SetFillModeProp (UI_FILL_MODE)

UI_FILL_MODE	GetFillModeProp () const

void	SetHatchingDirty ()

const SHAPE_POLY_SET &	GetHatching () const

bool	IsClosed () const

COLOR4D	GetFillColor () const

void	SetFillColor (const COLOR4D &aColor)

void	SetWidth (int aWidth)

virtual int	GetEffectiveWidth () const

virtual int	GetHatchLineWidth () const

virtual int	GetHatchLineSpacing () const

void	SetLineStyle (const LINE_STYLE aStyle)

LINE_STYLE	GetLineStyle () const

void	SetLineColor (const COLOR4D &aColor)

COLOR4D	GetLineColor () const

void	SetShape (SHAPE_T aShape)

SHAPE_T	GetShape () const

const VECTOR2I &	GetStart () const
	Return the starting point of the graphic.

int	GetStartY () const

int	GetStartX () const

void	SetStart (const VECTOR2I &aStart)

void	SetStartY (int y)

void	SetStartX (int x)

void	SetCenterY (int y)

void	SetCenterX (int x)

const VECTOR2I &	GetEnd () const
	Return the ending point of the graphic.

int	GetEndY () const

int	GetEndX () const

void	SetEnd (const VECTOR2I &aEnd)

void	SetEndY (int aY)

void	SetEndX (int aX)

void	SetRadius (int aX)

virtual VECTOR2I	GetTopLeft () const

virtual VECTOR2I	GetBotRight () const

virtual void	SetTop (int val)

virtual void	SetLeft (int val)

virtual void	SetRight (int val)

virtual void	SetBottom (int val)

void	SetBezierC1 (const VECTOR2I &aPt)

const VECTOR2I &	GetBezierC1 () const

void	SetBezierC2 (const VECTOR2I &aPt)

const VECTOR2I &	GetBezierC2 () const

VECTOR2I	getCenter () const

void	SetCenter (const VECTOR2I &aCenter)

void	SetArcAngleAndEnd (const EDA_ANGLE &aAngle, bool aCheckNegativeAngle=false)
	Set the end point from the angle center and start.

EDA_ANGLE	GetArcAngle () const

EDA_ANGLE	GetSegmentAngle () const

bool	EndsSwapped () const
	Have the start and end points been swapped since they were set?

VECTOR2I	GetArcMid () const

std::vector< VECTOR2I >	GetRectCorners () const

std::vector< VECTOR2I >	GetCornersInSequence (EDA_ANGLE angle) const

void	CalcArcAngles (EDA_ANGLE &aStartAngle, EDA_ANGLE &aEndAngle) const
	Calc arc start and end angles such that aStartAngle < aEndAngle.

int	GetRadius () const

void	SetArcGeometry (const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd)
	Set the three controlling points for an arc.

void	SetCachedArcData (const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, const VECTOR2I &aCenter)
	Set the data used for mid point caching.

const std::vector< VECTOR2I > &	GetBezierPoints () const

void	DupPolyPointsList (std::vector< VECTOR2I > &aBuffer) const
	Duplicate the list of corners in a std::vector<VECTOR2I>.

int	GetPointCount () const

SHAPE_POLY_SET &	GetPolyShape ()

const SHAPE_POLY_SET &	GetPolyShape () const

bool	IsPolyShapeValid () const

void	SetPolyShape (const SHAPE_POLY_SET &aShape)

void	SetPolyPoints (const std::vector< VECTOR2I > &aPoints)

void	RebuildBezierToSegmentsPointsList (int aMaxError)
	Rebuild the m_bezierPoints vertex list that approximate the Bezier curve by a list of segments.

virtual std::vector< SHAPE * >	MakeEffectiveShapes (bool aEdgeOnly=false) const
	Make a set of SHAPE objects representing the EDA_SHAPE.

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

void	SetLength (const double &aLength)

void	SetRectangleHeight (const int &aHeight)

void	SetRectangleWidth (const int &aWidth)

void	SetRectangle (const long long int &aHeight, const long long int &aWidth)

void	SetCornerRadius (int aRadius)

int	GetCornerRadius () const

void	SetSegmentAngle (const EDA_ANGLE &aAngle)

bool	IsClockwiseArc () const

double	GetLength () const

int	GetRectangleHeight () const

int	GetRectangleWidth () const

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

int	Compare (const EDA_SHAPE *aOther) const

double	Similarity (const EDA_SHAPE &aOther) const

bool	operator== (const EDA_SHAPE &aOther) const

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

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

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

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

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

Public Attributes
const KIID	m_Uuid

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

Protected Member Functions
void	swapData (BOARD_ITEM *aImage) override

bool	isMoving () const override

int	getMaxError () const override

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

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

EDA_ITEM *	findParent (KICAD_T aType) const

wxString	getFriendlyName () const

void	setPosition (const VECTOR2I &aPos)

VECTOR2I	getPosition () const

virtual void	setFilled (bool aFlag)

void	move (const VECTOR2I &aMoveVector)

void	rotate (const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle)

void	flip (const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection)

void	scale (double aScale)

virtual EDA_ANGLE	getDrawRotation () const

const BOX2I	getBoundingBox () const

void	computeArcBBox (BOX2I &aBBox) const

bool	hitTest (const VECTOR2I &aPosition, int aAccuracy=0) const

bool	hitTest (const BOX2I &aRect, bool aContained, int aAccuracy=0) const

bool	hitTest (const SHAPE_LINE_CHAIN &aPoly, bool aContained) const

const std::vector< VECTOR2I >	buildBezierToSegmentsPointsList (int aMaxError) const

void	beginEdit (const VECTOR2I &aStartPoint)

bool	continueEdit (const VECTOR2I &aPosition)

void	calcEdit (const VECTOR2I &aPosition)

void	endEdit (bool aClosed=true)
	Finish editing the shape.

void	setEditState (int aState)

std::vector< SHAPE * >	makeEffectiveShapes (bool aEdgeOnly, bool aLineChainOnly=false) const
	Make a set of SHAPE objects representing the EDA_SHAPE.

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

Protected Attributes
bool	m_hasSolderMask

std::optional< int >	m_solderMaskMargin

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

TEARDROP_PARAMETERS	m_teardropParams
	Not all BOARD_CONNECTED_ITEMs support teardrops, but we want those that do to share a single section in the property inspector.

PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

EDA_ITEM_FLAGS	m_flags

EDA_ITEM *	m_parent
	Owner.

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

bool	m_forceVisible

bool	m_isRollover

bool	m_endsSwapped

SHAPE_T	m_shape

STROKE_PARAMS	m_stroke

FILL_T	m_fill

COLOR4D	m_fillColor

SHAPE_POLY_SET	m_hatching

bool	m_hatchingDirty

long long int	m_rectangleHeight

long long int	m_rectangleWidth

int	m_cornerRadius

double	m_segmentLength

EDA_ANGLE	m_segmentAngle

VECTOR2I	m_start

VECTOR2I	m_end

VECTOR2I	m_arcCenter

ARC_MID	m_arcMidData

VECTOR2I	m_bezierC1

VECTOR2I	m_bezierC2

std::vector< VECTOR2I >	m_bezierPoints

SHAPE_POLY_SET	m_poly

int	m_editState

bool	m_proxyItem

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
bool	m_localRatsnestVisible

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 37 of file pcb_shape.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum BOARD_ITEM::COMPARE_FLAGS : int

inherited

Enumerator
DRC
INSTANCE_TO_INSTANCE

Definition at line 433 of file board_item.h.

Constructor & Destructor Documentation

◆ PCB_SHAPE() [1/2]

PCB_SHAPE::PCB_SHAPE	(	BOARD_ITEM *	aParent,
		KICAD_T	aItemType,
		SHAPE_T	aShapeType )

Definition at line 51 of file pcb_shape.cpp.

References BOARD_CONNECTED_ITEM::BOARD_CONNECTED_ITEM(), BOARD_ITEM::BOARD_ITEM(), DEFAULT_LINE_WIDTH, EDA_SHAPE::EDA_SHAPE(), m_hasSolderMask, NO_FILL, and pcbIUScale.

Referenced by Clone(), CopyFrom(), PCB_SHAPE::cmp_drawings::operator()(), operator==(), operator==(), PCB_TEXTBOX::PCB_TEXTBOX(), Similarity(), and swapData().

◆ PCB_SHAPE() [2/2]

PCB_SHAPE::PCB_SHAPE	(	BOARD_ITEM *	aParent = nullptr,
		SHAPE_T	aShapeType = SHAPE_T::SEGMENT )

Definition at line 59 of file pcb_shape.cpp.

References BOARD_CONNECTED_ITEM::BOARD_CONNECTED_ITEM(), BOARD_ITEM::BOARD_ITEM(), DEFAULT_LINE_WIDTH, EDA_SHAPE::EDA_SHAPE(), m_hasSolderMask, NO_FILL, PCB_SHAPE_T, and pcbIUScale.

◆ ~PCB_SHAPE()

PCB_SHAPE::~PCB_SHAPE ( )

override

Definition at line 67 of file pcb_shape.cpp.

Member Function Documentation

Referenced by CREEPAGE_GRAPH::Addshape(), computeArcBBox(), KIGFX::PCB_PAINTER::draw(), GetArcAngle(), hitTest(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveArc(), SegmentIntersectsBoard(), and CREEPAGE_GRAPH::TransformEdgeToCreepShapes().

◆ calcEdit()

void EDA_SHAPE::calcEdit ( const VECTOR2I & aPosition )

protectedinherited

Definition at line 2065 of file eda_shape.cpp.

References ANGLE_180, ARC, BEZIER, CIRCLE, VECTOR2< T >::Distance(), GetArcAngle(), GetEnd(), getMaxError(), GetRadius(), GetShape(), GetStart(), KiROUND(), m_arcCenter, m_editState, m_end, m_poly, m_start, POLY, radius, RebuildBezierToSegmentsPointsList(), RECTANGLE, SEGMENT, SetArcGeometry(), SetBezierC1(), SetBezierC2(), SetEnd(), SetStart(), SHAPE_T_asString(), sq, VECTOR2< T >::SquaredEuclideanNorm(), UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_SHAPE::CalcEdit().

◆ ClassOf()

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

inlinestatic

Definition at line 51 of file pcb_shape.h.

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

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 138 of file eda_item.h.

References BRIGHTENED, and ClearFlags().

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

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 156 of file eda_item.h.

References ClearFlags(), and GetEditFlags().

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 144 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, and m_flags.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 137 of file eda_item.h.

References ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 169 of file eda_item.h.

References ClearFlags(), and GetTempFlags().

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

◆ Clone()

EDA_ITEM * PCB_SHAPE::Clone ( ) const

overridevirtual

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

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 758 of file pcb_shape.cpp.

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

Referenced by DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

◆ Compare()

int EDA_SHAPE::Compare ( const EDA_SHAPE * aOther ) const

inherited

Definition at line 2291 of file eda_shape.cpp.

References ARC, BEZIER, SHAPE_POLY_SET::CVertex(), EDA_SHAPE(), GetArcMid(), STROKE_PARAMS::GetLineStyle(), STROKE_PARAMS::GetWidth(), m_bezierC1, m_bezierC2, m_bezierPoints, m_cornerRadius, m_end, m_fill, m_poly, m_shape, m_start, m_stroke, POLY, RECTANGLE, TEST, TEST_E, TEST_PT, and SHAPE_POLY_SET::TotalVertices().

Referenced by SCH_SHAPE::compare(), and BOARD::cmp_drawings::operator()().

◆ computeArcBBox()

void EDA_SHAPE::computeArcBBox ( BOX2I & aBBox ) const

protectedinherited

Definition at line 1779 of file eda_shape.cpp.

References ANGLE_0, ANGLE_180, ANGLE_270, ANGLE_90, CalcArcAngles(), GetRadius(), IsAnyFill(), m_arcCenter, m_end, m_start, BOX2< Vec >::Merge(), EDA_ANGLE::Normalize(), radius, and BOX2< Vec >::SetOrigin().

Referenced by getBoundingBox().

◆ continueEdit()

bool EDA_SHAPE::continueEdit ( const VECTOR2I & aPosition )

protectedinherited

Definition at line 2031 of file eda_shape.cpp.

References SHAPE_LINE_CHAIN::Append(), ARC, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::GetPointCount(), GetShape(), m_editState, m_poly, POLY, RECTANGLE, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by SCH_SHAPE::ContinueEdit().

◆ CopyFrom()

void PCB_SHAPE::CopyFrom ( const BOARD_ITEM * aOther )

overridevirtual

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 72 of file pcb_shape.cpp.

References BOARD_ITEM::BOARD_ITEM(), PCB_SHAPE(), PCB_SHAPE_T, and EDA_ITEM::Type().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 253 of file board_item.cpp.

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

◆ Deserialize()

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

overridevirtual

Deserializes the given protobuf message into this object.

Parameters

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

Returns: true if unpacking and deserialization succeeded

Reimplemented from SERIALIZABLE.

Reimplemented in PCB_TEXTBOX.

Definition at line 100 of file pcb_shape.cpp.

References EDA_SHAPE::Deserialize(), FromProtoEnum(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_arcMidData, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_editState, EDA_SHAPE::m_end, EDA_SHAPE::m_endsSwapped, EDA_SHAPE::m_proxyItem, EDA_SHAPE::m_start, EDA_ITEM::m_Uuid, SetLayer(), BOARD_ITEM::SetLocked(), and BOARD_CONNECTED_ITEM::UnpackNet().

◆ Duplicate()

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

virtualinherited

Create a copy of this BOARD_ITEM.

Parameters

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

Reimplemented in FOOTPRINT.

Definition at line 283 of file board_item.cpp.

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

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

◆ DupPolyPointsList()

void EDA_SHAPE::DupPolyPointsList ( std::vector< VECTOR2I > & aBuffer ) const

inherited

Duplicate the list of corners in a std::vector<VECTOR2I>.

It must be used only to convert the SHAPE_POLY_SET internal corner buffer to a list of VECTOR2Is, and nothing else, because it duplicates the buffer, that is inefficient to know for instance the corner count.

Definition at line 1958 of file eda_shape.cpp.

References m_poly.

Referenced by PCB_GRID_HELPER::computeAnchors(), SegmentIntersectsBoard(), and CREEPAGE_GRAPH::TransformEdgeToCreepShapes().

◆ endEdit()

void EDA_SHAPE::endEdit ( bool aClosed = true )

protectedinherited

Finish editing the shape.

Parameters

aClosed Should polygon shapes be closed (yes for pcbnew/fpeditor, no for libedit).

Definition at line 2227 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::GetPointCount(), GetShape(), m_poly, POLY, RECTANGLE, SHAPE_LINE_CHAIN::Remove(), SEGMENT, SHAPE_LINE_CHAIN::SetClosed(), SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by SCH_SHAPE::EndEdit().

◆ EndsSwapped()

bool EDA_SHAPE::EndsSwapped ( ) const

inlineinherited

Have the start and end points been swapped since they were set?

Returns: true if they have.

Definition at line 281 of file eda_shape.h.

References m_endsSwapped.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 75 of file eda_item.cpp.

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

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

◆ Flip()

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

overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters

aCentre	the rotation point.
aFlipDirection	the flip direction

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 570 of file pcb_shape.cpp.

References EDA_SHAPE::flip(), FlipLayer(), BOARD_ITEM::GetBoard(), GetLayer(), and SetLayer().

Referenced by PCB_TEXTBOX::Flip(), and CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex().

◆ flip()

void EDA_SHAPE::flip	(	const VECTOR2I &	aCentre,
		FLIP_DIRECTION	aFlipDirection )

inlineinherited

Definition at line 255 of file eda_shape.h.

References m_bezierC1.

Referenced by PCB_IO_IPC2581::addShape(), GRAPHICS_CLEANER::areEquivalent(), KI_TEST::CheckFpShape(), ConnectBoardShapes(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), formatBezier(), hash_fp_item(), FOOTPRINT::cmp_drawings::operator()(), BRDITEMS_PLOTTER::PlotShape(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveBezier(), Serialize(), GRAPHICS_IMPORTER::setupSplineOrLine(), shapeNeedsUpdate(), TransformShapeToPolygon(), and BEZIER_GEOM_SYNCER::updateBezier().

◆ GetBezierC2()

const VECTOR2I & EDA_SHAPE::GetBezierC2 ( ) const

inlineinherited

◆ GetBezierPoints()

const std::vector< VECTOR2I > & EDA_SHAPE::GetBezierPoints ( ) const

inlineinherited

Definition at line 320 of file eda_shape.h.

References m_bezierPoints.

Referenced by FEATURES_MANAGER::AddShape(), KIGFX::PCB_PAINTER::draw(), GRAPHICS_CLEANER::isNullShape(), CONVERT_TOOL::makePolysFromChainedSegs(), processShapeSegment(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), and GRAPHICS_IMPORTER::setupSplineOrLine().

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 88 of file board_item.cpp.

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

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 79 of file board_item.cpp.

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

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

◆ GetBotRight()

virtual VECTOR2I EDA_SHAPE::GetBotRight ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 247 of file eda_shape.h.

References GetEnd().

Referenced by KIGFX::PCB_PAINTER::draw(), RECTANGLE_POINT_EDIT_BEHAVIOR::MakePoints(), and RECTANGLE_POINT_EDIT_BEHAVIOR::UpdatePoints().

◆ GetBoundingBox()

const BOX2I PCB_SHAPE::GetBoundingBox ( ) const

inlineoverridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 121 of file pcb_shape.h.

References EDA_SHAPE::getBoundingBox().

Referenced by BOARD_ADAPTER::addShape(), PCB_TEXTBOX::HitTest(), PCB_TEXTBOX::HitTest(), and UpdateHatching().

◆ getBoundingBox()

const BOX2I EDA_SHAPE::getBoundingBox ( ) const

protectedinherited

Definition at line 1229 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, computeArcBBox(), GetEnd(), GetRadius(), GetRectCorners(), GetStart(), GetWidth(), BOX2< Vec >::Inflate(), m_bezierPoints, m_poly, m_shape, BOX2< Vec >::Merge(), BOX2< Vec >::Normalize(), POLY, RECTANGLE, SEGMENT, BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::GetBoundingBox(), SCH_SHAPE::GetBoundingBox(), getCenter(), GetCornersInSequence(), and hitTest().

◆ GetCenter()

VECTOR2I PCB_SHAPE::GetCenter ( ) const

inlineoverridevirtual

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

Returns: center point of the item

Reimplemented from BOARD_ITEM.

Definition at line 81 of file pcb_shape.h.

References EDA_SHAPE::getCenter().

Referenced by PCB_GRID_HELPER::AddConstructionItems(), FEATURES_MANAGER::AddShape(), BOARD_ADAPTER::addShape(), PCB_IO_IPC2581::addShape(), GRAPHICS_CLEANER::areEquivalent(), KI_TEST::CheckFpShape(), PCB_GRID_HELPER::computeAnchors(), ALTIUM_PCB::ConvertArcs6ToBoardItemOnLayer(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), GENCAD_EXPORTER::footprintWriteShape(), GetConnectionPoints(), GetFocusPosition(), hash_fp_item(), idf_export_outline(), DSN::SPECCTRA_DB::makeIMAGE(), RECTANGLE_POINT_EDIT_BEHAVIOR::MakePoints(), CONVERT_TOOL::makePolysFromClosedGraphics(), FOOTPRINT::cmp_drawings::operator()(), PCB_IO_EAGLE::packageRectangle(), BRDITEMS_PLOTTER::PlotShape(), processClosedShape(), OUTSET_ROUTINE::ProcessItem(), POLYGON_BOOLEAN_ROUTINE::ProcessShape(), EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), SegmentIntersectsBoard(), AR_MATRIX::TraceSegmentPcb(), CREEPAGE_GRAPH::TransformEdgeToCreepShapes(), CIRCLE_GEOM_SYNCER::updateCenterPoint(), CIRCLE_GEOM_SYNCER::updateCenterRadius(), RECTANGLE_GEOM_SYNCER::updateCenterSize(), ARC_GEOM_SYNCER::updateCSA(), RECTANGLE_POINT_EDIT_BEHAVIOR::UpdateItem(), RECTANGLE_POINT_EDIT_BEHAVIOR::UpdatePoints(), and LINE_GEOM_SYNCER::updateStartMidpoint().

◆ getCenter()

VECTOR2I EDA_SHAPE::getCenter ( ) const

inherited

Definition at line 955 of file eda_shape.cpp.

References ARC, BEZIER, BOX2< Vec >::Centre(), CIRCLE, getBoundingBox(), m_arcCenter, m_end, m_shape, m_start, POLY, RECTANGLE, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by CREEPAGE_GRAPH::Addshape(), BOOST_AUTO_TEST_CASE(), CalcArcAngles(), PCB_SHAPE::GetCenter(), SCH_SHAPE::GetCenter(), getPosition(), hitTest(), hitTest(), makeEffectiveShapes(), SCH_SHAPE::Plot(), PLOTTER::ThickArc(), TransformShapeToPolygon(), and UpdateHatching().

◆ GetClass()

wxString PCB_SHAPE::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements KIGFX::VIEW_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 56 of file pcb_shape.h.

◆ GetClearanceOverrides()

virtual std::optional< int > BOARD_CONNECTED_ITEM::GetClearanceOverrides ( wxString * aSource ) const

inlinevirtualinherited

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

Parameters

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

Returns: the clearance in internal units.

Reimplemented in PAD.

Definition at line 161 of file board_connected_item.h.

Referenced by DRC_ENGINE::EvalRules().

◆ GetConnectionPoints()

std::vector< VECTOR2I > PCB_SHAPE::GetConnectionPoints ( ) const

Returns: a list of connection points (may be empty): points where this shape can form electrical connections to other shapes that are natural "start/end" points.

Definition at line 260 of file pcb_shape.cpp.

References ARC, BEZIER, CIRCLE, circle(), EDA_SHAPE::GetArcMid(), GetCenter(), KIGEOM::GetCircleKeyPoints(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::IsSolidFill(), KI_FALLTHROUGH, EDA_SHAPE::m_shape, POLY, RECTANGLE, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), UNDEFINED, and UNIMPLEMENTED_FOR.

Referenced by CN_LIST::Add(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), and PNS_KICAD_IFACE_BASE::syncGraphicalItem().

◆ GetCornerRadius()

int EDA_SHAPE::GetCornerRadius ( ) const

inherited

◆ GetCorners()

std::vector< VECTOR2I > PCB_SHAPE::GetCorners ( ) const

virtual

Return 4 corners for a rectangle or rotated rectangle (stored as a poly).

Unimplemented for other shapes.

Definition at line 443 of file pcb_shape.cpp.

References EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetShape(), SHAPE_POLY_SET::OutlineCount(), POLY, RECTANGLE, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by BOARD_ADAPTER::addShape(), and KIGFX::PCB_PAINTER::draw().

◆ GetCornersInSequence()

std::vector< VECTOR2I > EDA_SHAPE::GetCornersInSequence ( EDA_ANGLE angle ) const

inherited

◆ GetDisplayNetname()

const wxString & BOARD_CONNECTED_ITEM::GetDisplayNetname ( ) const

inherited

Returns: the unescaped short netname.

Definition at line 171 of file board_connected_item.cpp.

References emptyString, BOARD_ITEM::GetBoard(), and m_netinfo.

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

◆ getDrawRotation()

virtual EDA_ANGLE EDA_SHAPE::getDrawRotation ( ) const

inlineprotectedvirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 449 of file eda_shape.h.

References ANGLE_0.

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveHoleShape()

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

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 336 of file board_item.cpp.

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

Referenced by collidesWithArea(), DRAWING_TOOL::DrawVia(), DRC_RTREE::Insert(), DRC_TEST_PROVIDER_SILK_CLEARANCE::Run(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::testAgainstEdge(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetEffectiveNetClass()

NETCLASS * BOARD_CONNECTED_ITEM::GetEffectiveNetClass ( ) const

virtualinherited

Return the NETCLASS for this item.

Note: Do not return a std::shared_ptr from this. It is used heavily in DRC, and the std::shared_ptr stuff shows up large in performance profiling.

Definition at line 126 of file board_connected_item.cpp.

References BOARD_ITEM::GetBoard(), NET_SETTINGS::GetDefaultNetclass(), BOARD::GetDesignSettings(), m_netinfo, and BOARD_DESIGN_SETTINGS::m_NetSettings.

Referenced by PCB_TUNING_PATTERN::CreateNew(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), PCB_TUNING_PATTERN::EditStart(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), PCB_VIA::GetDrillValue(), BOARD_INSPECTION_TOOL::getItemDescription(), LENGTH_DELAY_CALCULATION::GetLengthCalculationItem(), PAD::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), GetNetClassName(), hasExactNetclassFunc(), hasNetclassFunc(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), PNS::DP_MEANDER_PLACER::Start(), PNS::MEANDER_PLACER::Start(), PNS::MEANDER_SKEW_PLACER::Start(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem().

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > PCB_SHAPE::GetEffectiveShape	(	PCB_LAYER_ID	aLayer = UNDEFINED_LAYER,
		FLASHING	aFlash = FLASHING::DEFAULT ) const

overridevirtual

Make a set of SHAPE objects representing the PCB_SHAPE.

Caller owns the objects.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 775 of file pcb_shape.cpp.

References EDA_SHAPE::MakeEffectiveShapes().

Referenced by doConvertOutlineToPolygon(), and PCB_TEXTBOX::GetEffectiveShape().

◆ GetEffectiveWidth()

virtual int EDA_SHAPE::GetEffectiveWidth ( ) const

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 157 of file eda_shape.h.

References GetWidth().

Referenced by GetHatchLineWidth(), and makeEffectiveShapes().

◆ GetEmbeddedFiles()

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )

inlinevirtualinherited

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

Definition at line 468 of file eda_item.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::Parse().

◆ GetEmbeddedFonts()

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

overridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 401 of file board_item.cpp.

References GetBoard().

◆ GetEnd()

const VECTOR2I & EDA_SHAPE::GetEnd ( ) const

References ARC, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CPoint(), EDA_SHAPE::GetArcMid(), GetCenter(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetStart(), EDA_SHAPE::IsAnyFill(), EDA_SHAPE::m_shape, SHAPE_POLY_SET::Outline(), POLY, RECTANGLE, VECTOR2< T >::x, and VECTOR2< T >::y.

◆ GetFontMetrics()

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

inherited

Definition at line 132 of file board_item.cpp.

References KIFONT::METRICS::Default().

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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 171 of file view_item.h.

References m_forcedTransparency.

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

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 346 of file board_item.cpp.

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

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

◆ GetFriendlyName()

wxString PCB_SHAPE::GetFriendlyName ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 66 of file pcb_shape.h.

References EDA_SHAPE::getFriendlyName().

Referenced by GetItemDescription().

◆ getFriendlyName()

wxString EDA_SHAPE::getFriendlyName ( ) const

protectedinherited

Definition at line 1147 of file eda_shape.cpp.

References _, ARC, BEZIER, CIRCLE, IsProxyItem(), m_shape, POLY, RECTANGLE, and SEGMENT.

Referenced by PCB_SHAPE::GetFriendlyName(), and ShapeGetMsgPanelInfo().

◆ GetHatching()

const SHAPE_POLY_SET & EDA_SHAPE::GetHatching ( ) const

inlineinherited

Definition at line 148 of file eda_shape.h.

References m_hatching.

Referenced by FEATURES_MANAGER::AddShape(), BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), hitTest(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), and TransformShapeToPolygon().

◆ GetHatchLineSpacing()

virtual int EDA_SHAPE::GetHatchLineSpacing ( ) const

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 159 of file eda_shape.h.

References GetHatchLineWidth().

Referenced by UpdateHatching(), and PCB_SHAPE::UpdateHatching().

◆ GetHatchLineWidth()

virtual int EDA_SHAPE::GetHatchLineWidth ( ) const

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 158 of file eda_shape.h.

References GetEffectiveWidth().

Referenced by GetHatchLineSpacing(), and UpdateHatching().

◆ GetItemDescription()

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

overridevirtual

Return a user-visible description string of this item.

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

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

Parameters

aLong indicates a long string is acceptable

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 704 of file pcb_shape.cpp.

References _, FPHOLDER, BOARD_ITEM::GetBoard(), GetFriendlyName(), BOARD_ITEM::GetLayerName(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_ITEM::GetParentFootprint(), FOOTPRINT::GetReference(), and BOARD_ITEM::IsOnCopperLayer().

◆ GetLayer()

PCB_LAYER_ID PCB_SHAPE::GetLayer ( ) const

inlineoverridevirtual

Return the primary layer this item is on.

Reimplemented from BOARD_ITEM.

Definition at line 71 of file pcb_shape.h.

References BOARD_ITEM::m_layer.

Referenced by CN_LIST::Add(), BOARD_ADAPTER::addFootprintShapes(), BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), BuildBoardPolygonOutlines(), CONVERT_TOOL::CreateLines(), KIGFX::PCB_PAINTER::draw(), findClosestOutlineGap(), Flip(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), EDIT_TOOL::ModifyLines(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), BRDITEMS_PLOTTER::PlotBoardGraphicItem(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotShape(), DOGBONE_CORNER_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), LINE_FILLET_ROUTINE::ProcessLinePair(), POLYGON_BOOLEAN_ROUTINE::ProcessShape(), PAD::Recombine(), Serialize(), PCB_TEXTBOX::Serialize(), shapeNeedsUpdate(), Similarity(), StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), TestBoardOutlinesGraphicItems(), FOOTPRINT::TransformFPShapesToPolySet(), transformFPTextToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), UpdateHatching(), ViewGetLayers(), and PCB_TEXTBOX::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 180 of file board_item.cpp.

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

◆ GetLayerSet()

LSET PCB_SHAPE::GetLayerSet ( ) const

overridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 230 of file pcb_shape.cpp.

References B_Cu, B_Mask, F_Cu, F_Mask, m_hasSolderMask, and BOARD_ITEM::m_layer.

Referenced by KI_TEST::CheckFpShape(), PCB_IO_KICAD_SEXPR::format(), BRDITEMS_PLOTTER::PlotShape(), and PCB_SELECTION_TOOL::selectAllConnectedShapes().

◆ GetLength()

double EDA_SHAPE::GetLength ( ) const

inherited

Returns: the length of the segment using the hypotenuse calculation.

Definition at line 384 of file eda_shape.cpp.

References ARC, EDA_ANGLE::AsRadians(), BEZIER, VECTOR2< T >::Distance(), GetArcAngle(), GetEnd(), GetRadius(), GetStart(), m_bezierPoints, m_poly, m_shape, POLY, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by DRAWING_TOOL::drawShape(), DOGBONE_CORNER_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), LINE_EXTENSION_ROUTINE::ProcessLinePair(), LINE_FILLET_ROUTINE::ProcessLinePair(), ShapeGetMsgPanelInfo(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetLineColor()

COLOR4D EDA_SHAPE::GetLineColor ( ) const

inlineinherited

Definition at line 165 of file eda_shape.h.

References m_stroke.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ GetLineStyle()

LINE_STYLE EDA_SHAPE::GetLineStyle ( ) const

inherited

Definition at line 2505 of file eda_shape.cpp.

References DEFAULT, m_stroke, and SOLID.

Referenced by EXPORTER_STEP::buildGraphic3DShape(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), hash_fp_item(), PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC(), and Serialize().

◆ GetLocalClearance() [1/2]

virtual std::optional< int > BOARD_CONNECTED_ITEM::GetLocalClearance ( ) const

inlinevirtualinherited

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

Returns: the clearance (if any is specified) in internal units.

Reimplemented in PAD, and ZONE.

Definition at line 171 of file board_connected_item.h.

Referenced by DRC_ENGINE::EvalRules().

◆ GetLocalClearance() [2/2]

virtual std::optional< int > BOARD_CONNECTED_ITEM::GetLocalClearance ( wxString * aSource ) const

inlinevirtualinherited

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

Parameters

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

Returns: the clearance (if any is specified) in internal units.

Reimplemented in PAD, and ZONE.

Definition at line 182 of file board_connected_item.h.

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const

inlineinherited

Definition at line 201 of file board_connected_item.h.

References m_localRatsnestVisible.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint().

◆ GetLocalSolderMaskMargin()

std::optional< int > PCB_SHAPE::GetLocalSolderMaskMargin ( ) const

inline

Definition at line 198 of file pcb_shape.h.

References m_solderMaskMargin.

Referenced by DRC_ENGINE::EvalRules(), PCB_IO_KICAD_SEXPR::format(), and PCB_SHAPE_DESC::PCB_SHAPE_DESC().

◆ GetMaxError()

int BOARD_ITEM::GetMaxError ( ) const

inherited

Definition at line 138 of file board_item.cpp.

References ARC_HIGH_DEF, and GetBoard().

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

◆ getMaxError()

int PCB_SHAPE::getMaxError ( ) const

overrideprotectedvirtual

Reimplemented from EDA_SHAPE.

Definition at line 781 of file pcb_shape.cpp.

References BOARD_ITEM::GetMaxError().

◆ GetMenuImage()

BITMAPS PCB_SHAPE::GetMenuImage ( ) const

overridevirtual

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

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

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 749 of file pcb_shape.cpp.

References add_dashed_line, BOARD_ITEM::GetParentFootprint(), and show_mod_edge.

◆ GetMsgPanelInfo()

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

overridevirtual

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

Parameters

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 685 of file pcb_shape.cpp.

References _, BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetParentFootprint(), BOARD_ITEM::IsLocked(), PCB_EDIT_FRAME_NAME, and EDA_SHAPE::ShapeGetMsgPanelInfo().

◆ GetNet()

NETINFO_ITEM * BOARD_CONNECTED_ITEM::GetNet ( ) const

inlineinherited

Return #NET_INFO object for a given item.

Definition at line 82 of file board_connected_item.h.

References m_netinfo.

Referenced by PNS_KICAD_IFACE::createBoardItem(), EDIT_TOOL::DragArcTrack(), PCB_TUNING_PATTERN::EditStart(), EDIT_TOOL::FilletTracks(), PNS::NODE::FindItemByParent(), MODEL_ZONES_OVERVIEW::GetValueByRow(), PCB_TUNING_PATTERN::initBaseLines(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), BOARD_EDITOR_CONTROL::RepairBoard(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), PNS_KICAD_IFACE_BASE::syncPad(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetNetClassName()

wxString BOARD_CONNECTED_ITEM::GetNetClassName ( ) const

inherited

Returns the name of the effective netclass.

Primarily for the use of the property system.

Definition at line 135 of file board_connected_item.cpp.

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

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), and main().

◆ GetNetCode()

int BOARD_CONNECTED_ITEM::GetNetCode ( ) const

inherited

Returns: the net code.

Definition at line 118 of file board_connected_item.cpp.

References m_netinfo.

Referenced by CREEPAGE_GRAPH::AddNetElements(), TEARDROP_MANAGER::areItemsInSameZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), ZONE_FILLER::buildCopperItemClearances(), KI_TEST::CheckFpZone(), connectedItemFilter(), GENCAD_EXPORTER::createRoutesSection(), TEARDROP_MANAGER::createTeardrop(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::ExchangeFootprint(), extractDiffPairCoupledItems(), ZONE_FILLER::Fill(), MULTICHANNEL_TOOL::fixupNet(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), CONNECTIVITY_DATA::GetConnectedItems(), ZONE::GetInteractingZones(), PCB_TRACK::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), GetNetnameMsg(), CONNECTIVITY_DATA::GetRatsnestForItems(), CONNECTIVITY_DATA::GetRatsnestForPad(), BOARD_INSPECTION_TOOL::highlightNet(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), CONNECTIVITY_DATA::IsConnectedOnLayer(), ZONE::IsIsland(), ZONE_FILLER::knockoutThermalReliefs(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), AR_AUTOPLACER::nearestPad(), ROUTER_TOOL::NeighboringSegmentFilter(), DIALOG_DRC::OnDRCItemSelected(), PCB_TRACK::cmp_tracks::operator()(), ZONE_SETTINGS::operator<<(), BRDITEMS_PLOTTER::PlotShape(), process(), BOARD_EDITOR_CONTROL::RepairBoard(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), ZONE::SameNet(), PCB_SELECTION_CONDITIONS::sameNetFunc(), PCB_SELECTION_TOOL::selectNet(), ZONE::Similarity(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), BOARD::TracksInNet(), NETINFO_MAPPING::Update(), PCB_CONTROL::UpdateMessagePanel(), PCB_TRACK::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inherited

Returns: the full netname.

Definition at line 141 of file board_connected_item.cpp.

References m_netinfo.

Referenced by STEP_PCB_MODEL::AddPadShape(), MODEL_ZONES_OVERVIEW::ApplyFilter(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), EXPORTER_STEP::buildGraphic3DShape(), EXPORTER_STEP::buildTrack3DShape(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PAD::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), GetNetnameMsg(), ZONE_SEARCH_HANDLER::getResultCell(), BOARD_INSPECTION_TOOL::InspectClearance(), isCoupledDiffPairFunc(), FABMASTER::loadZone(), PackNet(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), BRDITEMS_PLOTTER::PlotZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetNetnameMsg()

wxString BOARD_CONNECTED_ITEM::GetNetnameMsg ( ) const

inherited

Returns: the full netname or "<no net>" in square braces, followed by "(Not Found)" if the netcode is undefined.

Definition at line 147 of file board_connected_item.cpp.

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

Referenced by PAD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TRACK::GetItemDescription(), PCB_VIA::GetItemDescription(), and ZONE::GetItemDescription().

◆ GetOwnClearance()

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

virtualinherited

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

Parameters

aLayer	the layer in question.
aSource	[out] optionally reports the source as a user-readable string.

Returns: the clearance in internal units.

Reimplemented in PAD.

Definition at line 95 of file board_connected_item.cpp.

References CLEARANCE_CONSTRAINT, DRC_ENGINE::EvalRules(), BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), DRC_CONSTRAINT::GetName(), MINOPTMAX< T >::HasMin(), BOARD_DESIGN_SETTINGS::m_DRCEngine, MINOPTMAX< T >::Min(), and DRC_CONSTRAINT::Value().

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_TRACK::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), and ZONE::GetMsgPanelInfo().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( ) const

inlineinherited

Definition at line 210 of file board_item.h.

References EDA_ITEM::m_parent.

Referenced by PCB_EDIT_TABLE_TOOL::copyCell(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createTrackWithMargin(), DeleteStructure(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), getClosestGroup(), PCB_TABLECELL::GetColumn(), PCB_TABLECELL::GetColumnWidth(), PCB_TABLECELL::GetParentGroup(), PCB_TABLECELL::GetRow(), PCB_TABLECELL::GetRowHeight(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), memberOfGroupFunc(), EDIT_TOOL::MoveExact(), PAD::operator==(), PAD::PAD(), PAD::PAD(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_BOARD_OUTLINE::PCB_BOARD_OUTLINE(), PCB_FIELD::PCB_FIELD(), PCB_VIA::PCB_VIA(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), PCB_TABLECELL::SetColumnWidth(), PCB_TABLECELL::SetRowHeight(), PAD::Similarity(), PCB_BOARD_OUTLINE::Similarity(), SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), KIGFX::PCB_VIEW::Update(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ GetParentAsString()

wxString BOARD_ITEM::GetParentAsString ( ) const

inherited

For "parent" property.

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

References m_poly.

◆ GetPosition()

VECTOR2I PCB_SHAPE::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 79 of file pcb_shape.h.

References EDA_SHAPE::getPosition().

Referenced by PCB_IO_IPC2581::addLocationNode(), BOARD_ADAPTER::addShape(), KI_TEST::CheckFpShape(), PCB_GRID_HELPER::computeAnchors(), DRAWING_TOOL::DrawTable(), ODB::GetShapePosition(), hash_fp_item(), PCB_TABLE::Normalize(), ALTIUM_PCB::Parse(), OUTSET_ROUTINE::ProcessItem(), PCB_TEXTBOX::Serialize(), and PCB_TEXTBOX::SetTextAngle().

◆ getPosition()

VECTOR2I EDA_SHAPE::getPosition ( ) const

protectedinherited

Definition at line 373 of file eda_shape.cpp.

References ARC, getCenter(), m_poly, m_shape, m_start, and POLY.

Referenced by PCB_SHAPE::GetPosition(), SCH_SHAPE::GetPosition(), setPosition(), and UpdateHatching().

◆ GetRadius()

int EDA_SHAPE::GetRadius ( ) const

inherited

Definition at line 1029 of file eda_shape.cpp.

References ARC, CIRCLE, KiROUND(), m_arcCenter, m_end, m_shape, m_start, radius, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_GRID_HELPER::AddConstructionItems(), FEATURES_MANAGER::AddShape(), CREEPAGE_GRAPH::Addshape(), BOARD_ADAPTER::addShape(), PCB_IO_IPC2581::addShape(), BOOST_AUTO_TEST_CASE(), calcEdit(), CheckLibSymbolGraphics(), computeArcBBox(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), editArcEndpointKeepCenterAndRadius(), formatCircle(), getBoundingBox(), PCB_SHAPE::GetConnectionPoints(), PCB_SHAPE::GetFocusPosition(), SCH_SHAPE::GetItemDescription(), GetLength(), hash_fp_item(), hitTest(), hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), makeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromClosedGraphics(), ALTIUM_PCB::Parse(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), processClosedShape(), OUTSET_ROUTINE::ProcessItem(), POLYGON_BOOLEAN_ROUTINE::ProcessShape(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveCircle(), SegmentIntersectsBoard(), SetLibShapeFillAndColor(), SetSchShapeFillAndColor(), ShapeGetMsgPanelInfo(), CREEPAGE_GRAPH::TransformEdgeToCreepShapes(), TransformShapeToPolygon(), and UpdateHatching().

◆ GetRectangleHeight()

int EDA_SHAPE::GetRectangleHeight ( ) const

inherited

◆ GetRectangleWidth()

int EDA_SHAPE::GetRectangleWidth ( ) const

inherited

◆ GetRectCorners()

std::vector< VECTOR2I > EDA_SHAPE::GetRectCorners ( ) const

inherited

◆ GetSegmentAngle()

EDA_ANGLE EDA_SHAPE::GetSegmentAngle ( ) const

inherited

Definition at line 1095 of file eda_shape.cpp.

References GetEnd(), GetStart(), and RADIANS_T.

◆ GetShape()

SHAPE_T EDA_SHAPE::GetShape ( ) const

inlineinherited

Definition at line 168 of file eda_shape.h.

References m_shape.

Referenced by PCB_GRID_HELPER::AddConstructionItems(), PCB_POINT_EDITOR::addCorner(), SCH_POINT_EDITOR::addCornerCondition(), PCB_IO_IPC2581::addLocationNode(), PCB_IO_IPC2581::addPackage(), SCH_SHAPE::AddPoint(), FEATURES_MANAGER::AddShape(), BOARD_ADAPTER::addShape(), BOARD_ADAPTER::addShape(), PCB_IO_IPC2581::addShape(), GRAPHICS_CLEANER::areEquivalent(), beginEdit(), calcEdit(), canAddCorner(), canChamferCorner(), PCB_POINT_EDITOR::chamferCorner(), KI_TEST::CheckFpShape(), CheckLibSymbolGraphics(), PCB_GRID_HELPER::computeAnchors(), ConnectBoardShapes(), continueEdit(), CONVERT_TOOL::CreateLines(), doConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), EDA_BEZIER_POINT_EDIT_BEHAVIOR::EDA_BEZIER_POINT_EDIT_BEHAVIOR(), EDA_CIRCLE_POINT_EDIT_BEHAVIOR::EDA_CIRCLE_POINT_EDIT_BEHAVIOR(), EDA_POLYGON_POINT_EDIT_BEHAVIOR::EDA_POLYGON_POINT_EDIT_BEHAVIOR(), EDA_SEGMENT_POINT_EDIT_BEHAVIOR::EDA_SEGMENT_POINT_EDIT_BEHAVIOR(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_TABLECELL_POINT_EDIT_BEHAVIOR::EDA_TABLECELL_POINT_EDIT_BEHAVIOR(), endEdit(), PAD_TOOL::explodePad(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), EDIT_TOOL::Flip(), GENCAD_EXPORTER::footprintWriteShape(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_SHAPE::GetCorners(), FOOTPRINT::GetCoverageArea(), SCH_SHAPE::GetItemDescription(), SCH_SHAPE::GetMenuImage(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), ODB::GetShapePosition(), CONVERT_TOOL::getStartEndPoints(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), idf_export_outline(), SCH_SHAPE::IsEndPoint(), PCB_SELECTION_TOOL::isExpandableGraphicShape(), GRAPHICS_CLEANER::isNullShape(), DSN::SPECCTRA_DB::makeIMAGE(), RECTANGLE_POINT_EDIT_BEHAVIOR::MakePoints(), PCB_POINT_EDITOR::makePoints(), SCH_POINT_EDITOR::makePointsAndBehavior(), CONVERT_TOOL::makePolysFromClosedGraphics(), GRAPHICS_CLEANER::mergeRects(), ITEM_MODIFICATION_ROUTINE::ModifyLineOrDeleteIfZeroLength(), EDIT_TOOL::ModifyLines(), SCH_SHAPE::Normalize(), PCB_POINT_EDITOR::OnSelectionChange(), FOOTPRINT::cmp_drawings::operator()(), PCB_SHAPE::cmp_drawings::operator()(), operator==(), ALTIUM_PCB::Parse(), SCH_EDITOR_CONTROL::Paste(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), processClosedShape(), OUTSET_ROUTINE::ProcessItem(), POLYGON_BOOLEAN_ROUTINE::ProcessShape(), processShapeSegment(), PCB_POINT_EDITOR::removeCorner(), EDIT_TOOL::Rotate(), PCB_TEXTBOX::Rotate(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveBezier(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveCircle(), SCH_IO_KICAD_LEGACY_LIB_CACHE::savePolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveRectangle(), SCH_IO_KICAD_SEXPR::saveShape(), SCH_IO_KICAD_LEGACY_LIB_CACHE::SaveSymbol(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveSymbolDrawItem(), SegmentIntersectsBoard(), CONVERT_TOOL::SegmentToArc(), Serialize(), PCB_SHAPE::SetIsProxyItem(), SetLibShapeFillAndColor(), SetSchShapeFillAndColor(), shapeNeedsUpdate(), Similarity(), AR_MATRIX::TraceSegmentPcb(), CREEPAGE_GRAPH::TransformEdgeToCreepShapes(), PCB_TEXTBOX::TransformShapeToPolygon(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetShortNetname()

const wxString & BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

Definition at line 163 of file board_connected_item.cpp.

References emptyString, and m_netinfo.

Referenced by STEP_PCB_MODEL::AddPadShape(), PAD::IsFreePad(), and DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem().

◆ GetSolderMaskExpansion()

int PCB_SHAPE::GetSolderMaskExpansion ( ) const

Definition at line 185 of file pcb_shape.cpp.

References BOARD_ITEM::GetBoard(), BOARD::GetDesignSettings(), GetWidth(), MINOPTMAX< T >::HasOpt(), EDA_SHAPE::IsSolidFill(), BOARD_DESIGN_SETTINGS::m_DRCEngine, BOARD_ITEM::m_layer, m_solderMaskMargin, DRC_CONSTRAINT::m_Value, MINOPTMAX< T >::Opt(), and SOLDER_MASK_EXPANSION_CONSTRAINT.

Referenced by BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), KIGFX::PCB_PAINTER::draw(), BRDITEMS_PLOTTER::PlotShape(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), and DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

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

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

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 288 of file eda_item.h.

References GetPosition().

◆ GetStart()

const VECTOR2I & EDA_SHAPE::GetStart ( ) const

inlineinherited

Return the starting point of the graphic.

Definition at line 173 of file eda_shape.h.

References m_start.

◆ GetStartX()

int EDA_SHAPE::GetStartX ( ) const

inlineinherited

Definition at line 175 of file eda_shape.h.

References m_start.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_TEXTBOX::GetBotRight(), GetRectangleWidth(), PCB_TEXTBOX::GetTopLeft(), SCH_SHAPE::Normalize(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), and SetRectangleWidth().

◆ GetStartY()

int EDA_SHAPE::GetStartY ( ) const

inlineinherited

Definition at line 174 of file eda_shape.h.

const TEARDROP_PARAMETERS & BOARD_CONNECTED_ITEM::GetTeardropParams ( ) const

inlineinherited

Definition at line 204 of file board_connected_item.h.

References m_teardropParams.

◆ GetTeardropPreferZoneConnections()

bool BOARD_CONNECTED_ITEM::GetTeardropPreferZoneConnections ( ) const

inlineinherited

Definition at line 225 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropsEnabled()

bool BOARD_CONNECTED_ITEM::GetTeardropsEnabled ( ) const

inlineinherited

Definition at line 207 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 161 of file eda_item.h.

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

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

◆ GetTopLeft()

virtual VECTOR2I EDA_SHAPE::GetTopLeft ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 246 of file eda_shape.h.

References GetStart().

Referenced by KIGFX::PCB_PAINTER::draw(), RECTANGLE_POINT_EDIT_BEHAVIOR::MakePoints(), and RECTANGLE_POINT_EDIT_BEHAVIOR::UpdatePoints().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

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

Definition at line 392 of file eda_item.cpp.

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

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

◆ GetWidth()

int PCB_SHAPE::GetWidth ( ) const

bool PCB_SHAPE::HasLineStroke ( ) const

inlineoverridevirtual

Check if this item has line stoke properties.

See also: STROKE_PARAMS

Reimplemented from BOARD_ITEM.

Definition at line 89 of file pcb_shape.h.

◆ HasSolderMask()

bool PCB_SHAPE::HasSolderMask ( ) const

inline

Definition at line 195 of file pcb_shape.h.

References m_hasSolderMask.

Referenced by BOARD_ADAPTER::addShape(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), and BRDITEMS_PLOTTER::PlotShape().

◆ HitTest() [1/3]

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

inlineoverridevirtual

Test if aRect intersects this item.

Parameters

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 128 of file pcb_shape.h.

References EDA_SHAPE::hitTest().

◆ HitTest() [2/3]

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

inlineoverridevirtual

Test if aPoly intersects this item.

Parameters

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

Returns: True if aPoly contains or intersects the item.

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 133 of file pcb_shape.h.

References EDA_SHAPE::hitTest().

◆ HitTest() [3/3]

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

inlineoverridevirtual

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 123 of file pcb_shape.h.

References EDA_SHAPE::hitTest().

Referenced by DRAWING_TOOL::DrawVia(), and PCB_TEXTBOX::HitTest().

◆ hitTest() [1/3]

bool EDA_SHAPE::hitTest	(	const BOX2I &	aRect,
		bool	aContained,
		int	aAccuracy = 0 ) const

protectedinherited

◆ hitTest() [2/3]

bool EDA_SHAPE::hitTest	(	const SHAPE_LINE_CHAIN &	aPoly,
		bool	aContained ) const

protectedinherited

Definition at line 1640 of file eda_shape.cpp.

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

◆ hitTest() [3/3]

bool EDA_SHAPE::hitTest	(	const VECTOR2I &	aPosition,
		int	aAccuracy = 0 ) const

protectedinherited

Definition at line 1284 of file eda_shape.cpp.

References SHAPE_POLY_SET::Append(), ARC, BEZIER, CalcArcAngles(), CIRCLE, Collide(), SHAPE_POLY_SET::Collide(), SHAPE_POLY_SET::CollideEdge(), copy, VECTOR2< T >::Distance(), VECTOR2< T >::EuclideanNorm(), getCenter(), GetEnd(), GetHatching(), BEZIER_POLY::GetPoly(), GetRadius(), GetRectangleHeight(), GetRectangleWidth(), GetRectCorners(), GetStart(), GetWidth(), IsFilledForHitTesting(), IsHatchedFill(), IsProxyItem(), m_bezierC1, m_bezierC2, m_bezierPoints, m_cornerRadius, m_end, m_poly, m_shape, m_start, SHAPE_POLY_SET::NewOutline(), EDA_ANGLE::Normalize(), POLY, radius, RECTANGLE, SEGMENT, SHAPE_T_asString(), TestSegmentHit(), ROUNDRECT::TransformToPolygon(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::HitTest(), PCB_SHAPE::HitTest(), PCB_SHAPE::HitTest(), SCH_SHAPE::HitTest(), and SCH_SHAPE::HitTest().

◆ IsAnyFill()

bool EDA_SHAPE::IsAnyFill ( ) const

inlineinherited

Definition at line 112 of file eda_shape.h.

References GetFillMode(), and NO_FILL.

Referenced by computeArcBBox(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), FOOTPRINT::GetCoverageArea(), PCB_SHAPE::GetFocusPosition(), hitTest(), PAD::Recombine(), and PCB_SELECTION_TOOL::Selectable().

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 102 of file view_item.h.

References m_isBOARD_ITEM.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_GRID_HELPER::BestSnapAnchor(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), EDA_ITEM::EDA_ITEM(), MULTICHANNEL_TOOL::findOtherItemsInRuleArea(), PCB_BASE_FRAME::FocusOnItem(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD::Move(), PCB_GRID_HELPER::nearestAnchor(), PCB_CONTROL::Paste(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), PCB_SELECTION_TOOL::select(), PCB_SELECTION_TOOL::SelectAll(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), EDIT_TOOL::Swap(), BOARD_COMMIT::undoLevelItem(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), PCB_SELECTION_TOOL::UnselectAll(), KIGFX::PCB_VIEW::Update(), KIGFX::PCB_VIEW::UpdateCollidingItems(), EDIT_TOOL::updateModificationPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 129 of file eda_item.h.

References BRIGHTENED, and m_flags.

◆ IsClockwiseArc()

bool EDA_SHAPE::IsClockwiseArc ( ) const

inherited

Definition at line 1115 of file eda_shape.cpp.

References ARC, GetArcMid(), m_end, m_shape, m_start, SHAPE_T_asString(), UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by FEATURES_MANAGER::AddShape(), and PCB_IO_IPC2581::addShape().

◆ IsClosed()

bool EDA_SHAPE::IsClosed ( ) const

inherited

Definition at line 539 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, m_bezierPoints, m_poly, m_shape, POLY, RECTANGLE, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by SCH_POINT_EDITOR::addCorner(), PCB_SELECTION_TOOL::isExpandableGraphicShape(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), and UpdateHatching().

◆ IsConnected()

bool PCB_SHAPE::IsConnected ( ) const

overridevirtual

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

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

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 169 of file pcb_shape.cpp.

References BOARD_ITEM::GetParentFootprint(), and BOARD_ITEM::IsOnCopperLayer().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 128 of file eda_item.h.

References ENTERED, and m_flags.

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

◆ IsFilledForHitTesting()

virtual bool EDA_SHAPE::IsFilledForHitTesting ( ) const

inlinevirtualinherited

Reimplemented in SCH_RULE_AREA.

Definition at line 131 of file eda_shape.h.

References IsSolidFill().

Referenced by SCH_SELECTION_TOOL::GuessSelectionCandidates(), and hitTest().

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 211 of file eda_item.h.

References m_forceVisible.

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

◆ IsGroupableType()

bool BOARD_ITEM::IsGroupableType ( ) const

inherited

Definition at line 41 of file board_item.cpp.

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

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

◆ IsHatchedFill()

bool EDA_SHAPE::IsHatchedFill ( ) const

inlineinherited

Definition at line 124 of file eda_shape.h.

References CROSS_HATCH, GetFillMode(), HATCH, and REVERSE_HATCH.

Referenced by FEATURES_MANAGER::AddShape(), BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), KIGFX::PCB_PAINTER::draw(), hitTest(), makeEffectiveShapes(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), and TransformShapeToPolygon().

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in FOOTPRINT, and PAD.

Definition at line 103 of file board_item.cpp.

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 123 of file eda_item.h.

References IS_CHANGED, and m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ isMoving()

bool PCB_SHAPE::isMoving ( ) const

inlineoverrideprotectedvirtual

Reimplemented from EDA_SHAPE.

Definition at line 209 of file pcb_shape.h.

References EDA_ITEM::IsMoving().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

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

Reimplemented in PAD, PCB_GROUP, PCB_TRACK, and ZONE.

Definition at line 151 of file board_item.h.

References GetLayer(), and IsCopperLayer().

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::CheckNetTies(), DRC_ENGINE::EvalRules(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), PCB_SHAPE::GetItemDescription(), BOARD_INSPECTION_TOOL::InspectClearance(), PCB_SHAPE::IsConnected(), isCopper(), PCB_SELECTION_TOOL::isExpandableGraphicShape(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), PCB_SHAPE::SetLayer(), BOARD_CONNECTED_ITEM::SetNetCode(), shapeNeedsUpdate(), PCB_CONTROL::TrackDisplayMode(), PCB_CONTROL::UpdateMessagePanel(), and PCB_SHAPE::ViewGetLayers().

◆ IsOnLayer()

bool PCB_SHAPE::IsOnLayer ( PCB_LAYER_ID aLayer ) const

overridevirtual

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

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

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 212 of file pcb_shape.cpp.

References B_Cu, B_Mask, F_Cu, F_Mask, m_hasSolderMask, and BOARD_ITEM::m_layer.

Referenced by BOARD_ADAPTER::addFootprintShapes(), EXPORTER_STEP::buildGraphic3DShape(), GRAPHICS_CLEANER::fixBoardOutlines(), isEdge(), and PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog().

◆ IsPolyShapeValid()

bool EDA_SHAPE::IsPolyShapeValid ( ) const

inherited

Returns: true if the polygonal shape is valid (has more than 2 points).

Definition at line 1975 of file eda_shape.cpp.

References GetPolyShape(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by PCB_IO_KICAD_SEXPR::format(), BRDITEMS_PLOTTER::PlotShape(), and TransformShapeToPolygon().

◆ IsProxyItem()

bool PCB_SHAPE::IsProxyItem ( ) const

inlineoverridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 116 of file pcb_shape.h.

References EDA_SHAPE::m_proxyItem.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), PAD::Recombine(), and PCB_POINT_EDITOR::updateItem().

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 439 of file eda_item.h.

Referenced by Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References m_isRollover.

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

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 101 of file view_item.h.

References m_isSCH_ITEM.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 127 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 184 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsSideSpecific()

bool BOARD_ITEM::IsSideSpecific ( ) const

inherited

Definition at line 190 of file board_item.cpp.

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

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

◆ IsSolidFill()

bool EDA_SHAPE::IsSolidFill ( ) const

inlineinherited

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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

Parameters

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

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

Reimplemented in PCB_VIA.

Definition at line 173 of file board_item.h.

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

◆ IsType()

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

overridevirtual

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 137 of file pcb_shape.cpp.

References ARC, BEZIER, CIRCLE, Edge_Cuts, EDA_ITEM::IsType(), BOARD_ITEM::m_layer, EDA_SHAPE::m_shape, PCB_LOCATE_BOARD_EDGE_T, PCB_SHAPE_LOCATE_ARC_T, PCB_SHAPE_LOCATE_BEZIER_T, PCB_SHAPE_LOCATE_CIRCLE_T, PCB_SHAPE_LOCATE_POLY_T, PCB_SHAPE_LOCATE_RECT_T, PCB_SHAPE_LOCATE_SEGMENT_T, POLY, RECTANGLE, and SEGMENT.

◆ IterateForward() [1/2]

template<class T>

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

inlinestaticinherited

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

Definition at line 325 of file eda_item.h.

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

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

◆ IterateForward() [2/2]

template<class T>

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

inlinestaticinherited

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

Definition at line 345 of file eda_item.h.

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

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 207 of file board_item.cpp.

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

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

◆ lodScaleForThreshold()

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

staticprotectedinherited

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

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

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

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

Definition at line 39 of file view_item.cpp.

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

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

◆ MakeEffectiveShapes()

virtual std::vector< SHAPE * > EDA_SHAPE::MakeEffectiveShapes ( bool aEdgeOnly = false ) const

inlinevirtualinherited

Make a set of SHAPE objects representing the EDA_SHAPE.

Caller owns the objects.

Parameters

aEdgeOnly indicates only edges should be generated (even if 0 width), and no fill shapes.

Reimplemented in SCH_RULE_AREA, and SCH_SHAPE.

Definition at line 379 of file eda_shape.h.

References makeEffectiveShapes().

Referenced by BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_SHAPE::GetEffectiveShape(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), hitTest(), BRDITEMS_PLOTTER::PlotShape(), and PNS_KICAD_IFACE_BASE::syncGraphicalItem().

◆ makeEffectiveShapes()

std::vector< SHAPE * > EDA_SHAPE::makeEffectiveShapes	(	bool	aEdgeOnly,
		bool	aLineChainOnly = false ) const

protectedinherited

Make a set of SHAPE objects representing the EDA_SHAPE.

Caller owns the objects.

Parameters

aEdgeOnly	indicates only edges should be generated (even if 0 width), and no fill shapes.
aLineChainOnly	indicates SHAPE_POLY_SET is being abused slightly to represent a lineChain rather than a closed polygon.

Definition at line 1839 of file eda_shape.cpp.

References ANGLE_360, ARC, BEZIER, buildBezierToSegmentsPointsList(), CIRCLE, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::CSegment(), GetArcAngle(), getCenter(), GetEffectiveWidth(), GetEnd(), getMaxError(), GetPolyShape(), GetRadius(), GetRectangleHeight(), GetRectangleWidth(), GetRectCorners(), GetStart(), SHAPE_LINE_CHAIN::IsClosed(), IsHatchedFill(), IsProxyItem(), IsSolidFill(), m_arcCenter, m_cornerRadius, m_end, m_shape, m_start, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::PointCount(), POLY, RECTANGLE, SEGMENT, SHAPE_LINE_CHAIN::SegmentCount(), SHAPE_T_asString(), ROUNDRECT::TransformToPolygon(), and UNIMPLEMENTED_FOR.

Referenced by MakeEffectiveShapes(), and SCH_SHAPE::MakeEffectiveShapes().

◆ Matches() [1/2]

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

inlinevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

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

Definition at line 401 of file eda_item.h.

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 158 of file eda_item.cpp.

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

◆ Mirror()

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

overridevirtual

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

Parameters

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

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 578 of file pcb_shape.cpp.

References EDA_SHAPE::flip().

Referenced by PCB_TEXTBOX::Mirror().

◆ Move()

void PCB_SHAPE::Move ( const VECTOR2I & aMoveVector )

overridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 471 of file pcb_shape.cpp.

References move.

Referenced by PCAD2KICAD::PCAD_ARC::AddToBoard(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), PCB_TEXTBOX::Move(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), PCB_IO_EAGLE::packageWire(), GPCB_FPL_CACHE::parseFOOTPRINT(), PAD::Recombine(), RECTANGLE_POINT_EDIT_BEHAVIOR::UpdateItem(), and SHAPE_GROUP_POINT_EDIT_BEHAVIOR::UpdateItem().

◆ move()

void EDA_SHAPE::move ( const VECTOR2I & aMoveVector )

protectedinherited

Definition at line 722 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, KI_FALLTHROUGH, m_arcCenter, m_arcMidData, m_bezierC1, m_bezierC2, m_bezierPoints, m_end, m_hatchingDirty, m_poly, m_shape, m_start, POLY, RECTANGLE, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by SCH_TEXTBOX::Move().

◆ Normalize()

void PCB_SHAPE::Normalize ( )

overridevirtual

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

Reimplemented from BOARD_ITEM.

Definition at line 483 of file pcb_shape.cpp.

References SEG::A, SEG::B, end, BOX2< Vec >::GetEnd(), EDA_SHAPE::GetEnd(), BOX2< Vec >::GetPosition(), EDA_SHAPE::GetStart(), EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, BOX2< Vec >::Normalize(), POLY, RECTANGLE, SHAPE_LINE_CHAIN::Segment(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by DRAWING_TOOL::DrawRectangle(), NormalizeForCompare(), and PCB_TEXTBOX::Rotate().

◆ NormalizeForCompare()

void PCB_SHAPE::NormalizeForCompare ( )

overridevirtual

Normalize coordinates to compare 2 similar PCB_SHAPES similat to Normalize(), but also normalize SEGMENT end points needed only for graphic comparisons.

Reimplemented from BOARD_ITEM.

Definition at line 542 of file pcb_shape.cpp.

References end, EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), EDA_SHAPE::m_shape, Normalize(), SEGMENT, EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ operator<()

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

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

Definition at line 319 of file eda_item.cpp.

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

◆ operator==() [1/3]

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

inherited

Definition at line 2514 of file eda_shape.cpp.

References SHAPE_POLY_SET::CVertex(), EDA_SHAPE(), STROKE_PARAMS::GetLineStyle(), GetShape(), STROKE_PARAMS::GetWidth(), m_arcCenter, m_bezierC1, m_bezierC2, m_bezierPoints, m_end, m_fill, m_fillColor, m_poly, m_start, and m_stroke.

Referenced by PCB_SHAPE::operator==(), and SCH_SHAPE::operator==().

◆ operator==() [2/3]

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

overridevirtual

Implements BOARD_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 845 of file pcb_shape.cpp.

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

◆ operator==() [3/3]

bool PCB_SHAPE::operator== ( const PCB_SHAPE & aShape ) const

Definition at line 856 of file pcb_shape.cpp.

References NETINFO_ITEM::GetNetCode(), EDA_ITEM::m_flags, EDA_ITEM::m_forceVisible, m_hasSolderMask, BOARD_ITEM::m_isKnockout, BOARD_ITEM::m_isLocked, BOARD_ITEM::m_layer, BOARD_CONNECTED_ITEM::m_netinfo, m_solderMaskMargin, EDA_SHAPE::operator==(), PCB_SHAPE(), and EDA_ITEM::Type().

◆ PackNet()

void BOARD_CONNECTED_ITEM::PackNet ( kiapi::board::types::Net * aProto ) const

inherited

Definition at line 67 of file board_connected_item.cpp.

References GetNetname().

Referenced by PAD::Serialize(), PCB_ARC::Serialize(), PCB_SHAPE::Serialize(), PCB_TRACK::Serialize(), PCB_VIA::Serialize(), and ZONE::Serialize().

◆ RebuildBezierToSegmentsPointsList()

void EDA_SHAPE::RebuildBezierToSegmentsPointsList ( int aMaxError )

inherited

Rebuild the m_bezierPoints vertex list that approximate the Bezier curve by a list of segments.

Has meaning only for BEZIER shape.

Parameters

aMinSegLen is the max deviation between the polyline and the curve.

Definition at line 928 of file eda_shape.cpp.

References BEZIER, buildBezierToSegmentsPointsList(), m_bezierPoints, and m_shape.

Referenced by beginEdit(), calcEdit(), Deserialize(), flip(), GRAPHICS_CLEANER::isNullShape(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_ALTIUM::ParseEllipticalArc(), processShapeSegment(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), scale(), and GRAPHICS_IMPORTER::setupSplineOrLine().

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 174 of file eda_item.h.

◆ Replace() [1/2]

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

inlinevirtualinherited

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

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

Parameters

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

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

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

Definition at line 428 of file eda_item.h.

◆ Replace() [2/2]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 236 of file eda_item.cpp.

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

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

◆ Rotate()

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

overridevirtual

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 564 of file pcb_shape.cpp.

References EDA_SHAPE::rotate().

Referenced by PCAD2KICAD::PCAD_ARC::AddToBoard(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), ALTIUM_PCB::ConvertFills6ToBoardItem(), ALTIUM_PCB::ConvertFills6ToFootprintItem(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperParsePad6NonCopper(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), PCB_IO_EAGLE::packageWire(), GPCB_FPL_CACHE::parseFOOTPRINT(), PAD::Recombine(), PCB_TEXTBOX::Rotate(), and PCB_TARGET::TransformShapeToPolygon().

◆ rotate()

void EDA_SHAPE::rotate	(	const VECTOR2I &	aRotCentre,
		const EDA_ANGLE &	aAngle )

protectedinherited

Definition at line 820 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, EDA_ANGLE::IsCardinal(), KI_FALLTHROUGH, m_arcCenter, m_arcMidData, m_bezierC1, m_bezierC2, m_bezierPoints, m_end, m_hatchingDirty, m_poly, m_shape, m_start, POLY, RECTANGLE, RotatePoint(), SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::Rotate(), and SCH_SHAPE::Rotate().

◆ RunOnChildren()

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

inlinevirtualinherited

Invoke a function on all children.

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

Reimplemented in BOARD, FOOTPRINT, PCB_GROUP, and PCB_TABLE.

Definition at line 208 of file board_item.h.

References BOARD_ITEM().

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

◆ Scale()

void PCB_SHAPE::Scale ( double aScale )

Definition at line 477 of file pcb_shape.cpp.

References scale.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), and SHAPE_GROUP_POINT_EDIT_BEHAVIOR::UpdateItem().

◆ scale()

void EDA_SHAPE::scale ( double aScale )

protectedinherited

Definition at line 765 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, getMaxError(), KI_FALLTHROUGH, KiROUND(), m_arcCenter, m_bezierC1, m_bezierC2, m_end, m_hatchingDirty, m_poly, m_shape, m_start, POLY, RebuildBezierToSegmentsPointsList(), RECTANGLE, SEGMENT, SetPolyPoints(), SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

◆ Serialize()

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

overridevirtual

Serializes this object to the given Any message.

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

Parameters

aContainer will be filled with a message describing this object

Reimplemented from SERIALIZABLE.

Reimplemented in PCB_TEXTBOX.

Definition at line 79 of file pcb_shape.cpp.

References GetLayer(), BOARD_ITEM::IsLocked(), EDA_ITEM::m_Uuid, BOARD_CONNECTED_ITEM::PackNet(), EDA_SHAPE::Serialize(), and ToProtoEnum().

◆ Set() [1/4]

template<typename T>

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

inlineinherited

Definition at line 98 of file inspectable.h.

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

◆ Set() [2/4]

template<typename T>

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

inlineinherited

Definition at line 60 of file inspectable.h.

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

◆ Set() [3/4]

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

inlineinherited

Definition at line 43 of file inspectable.h.

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

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

◆ Set() [4/4]

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

inlineinherited

Definition at line 76 of file inspectable.h.

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

◆ SetArcAngleAndEnd()

void EDA_SHAPE::SetArcAngleAndEnd	(	const EDA_ANGLE &	aAngle,
		bool	aCheckNegativeAngle = false )

inherited

Set the end point from the angle center and start.

aAngle is:

clockwise in right-down coordinate system
counter-clockwise in right-up (libedit) coordinate system.

Definition at line 1132 of file eda_shape.cpp.

References ANGLE_0, m_arcCenter, m_end, m_endsSwapped, m_start, EDA_ANGLE::Normalize720(), and RotatePoint().

Referenced by PCAD2KICAD::PCAD_ARC::AddToBoard(), BOOST_AUTO_TEST_CASE(), ALTIUM_PCB::ConvertArcs6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertArcs6ToPcbShape(), DRAWING_TOOL::drawArc(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), PCB_IO_EAGLE::loadPlain(), SCH_IO_EAGLE::loadSymbolWire(), ARC_GEOM_SYNCER::OnCSAChange(), PCB_IO_EAGLE::packageWire(), and GPCB_FPL_CACHE::parseFOOTPRINT().

◆ SetArcGeometry()

void EDA_SHAPE::SetArcGeometry	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aMid,
		const VECTOR2I &	aEnd )

inherited

Set the three controlling points for an arc.

NB: these are NOT what's currently stored, so we have to do some calculations behind the scenes. However, they are what SHOULD be stored.

Definition at line 1065 of file eda_shape.cpp.

References CalcArcCenter(), GetArcMid(), m_arcCenter, m_arcMidData, m_end, m_endsSwapped, m_start, SetCachedArcData(), and VECTOR2< T >::SquaredEuclideanNorm().

Referenced by CREEPAGE_GRAPH::Addshape(), beginEdit(), BOOST_AUTO_TEST_CASE(), calcEdit(), ConnectBoardShapes(), Deserialize(), editArcMidKeepEndpoints(), PCB_IO_IPC2581::generateLayerSetNet(), FEATURES_MANAGER::InitFeatureList(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), ARC_GEOM_SYNCER::OnSMEChange(), SCH_SCREEN::Plot(), and CONVERT_TOOL::SegmentToArc().

◆ SetBezierC1()

void EDA_SHAPE::SetBezierC1 ( const VECTOR2I & aPt )

inlineinherited

Definition at line 254 of file eda_shape.h.

References m_bezierC1.

Referenced by beginEdit(), calcEdit(), ConnectBoardShapes(), Deserialize(), HelperGeneratePowerPortGraphics(), HelperGeneratePowerPortGraphics(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), BEZIER_GEOM_SYNCER::OnBezierChange(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseEllipse(), and SCH_IO_ALTIUM::ParseEllipticalArc().

◆ SetBezierC2()

void EDA_SHAPE::SetBezierC2 ( const VECTOR2I & aPt )

inlineinherited

Definition at line 257 of file eda_shape.h.

References m_bezierC2.

Referenced by beginEdit(), calcEdit(), ConnectBoardShapes(), Deserialize(), HelperGeneratePowerPortGraphics(), HelperGeneratePowerPortGraphics(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), BEZIER_GEOM_SYNCER::OnBezierChange(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseEllipse(), and SCH_IO_ALTIUM::ParseEllipticalArc().

◆ SetBottom()

virtual void EDA_SHAPE::SetBottom ( int val )

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 252 of file eda_shape.h.

References SetEndY().

Referenced by RECTANGLE_POINT_EDIT_BEHAVIOR::UpdateItem().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 135 of file eda_item.h.

References BRIGHTENED, and SetFlags().

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

◆ SetCachedArcData()

void EDA_SHAPE::SetCachedArcData	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aMid,
		const VECTOR2I &	aEnd,
		const VECTOR2I &	aCenter )

inherited

Set the data used for mid point caching.

If the controlling points remain constant, then we keep the midpoint the same as it was when read in. This minimizes VCS churn.

Parameters

aStart	Cached start point.
aMid	Cached mid point.
aEnd	Cached end point.
aCenter	Calculated center point using the preceeding three.

Reimplemented in SCH_SHAPE.

Definition at line 136 of file eda_shape.h.

References setFilled().

Referenced by PAD::AddPrimitivePoly(), PAD::AddPrimitivePoly(), ZONE_CREATE_HELPER::commitZone(), ALTIUM_PCB::ConvertFills6ToBoardItem(), ALTIUM_PCB::ConvertFills6ToFootprintItem(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawShape(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), ALTIUM_PCB::HelperParsePad6NonCopper(), FABMASTER::loadGraphics(), PCB_IO_EAGLE::loadPlain(), FABMASTER::loadPolygon(), CONVERT_TOOL::makePolysFromClosedGraphics(), GRAPHICS_CLEANER::mergeRects(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), PAD::Recombine(), SCH_TABLECELL_DESC::SCH_TABLECELL_DESC(), CONVERT_TOOL::SegmentToArc(), and SetFillModeProp().

◆ setFilled()

virtual void EDA_SHAPE::setFilled ( bool aFlag )

inlineprotectedvirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 439 of file eda_shape.h.

References FILLED_SHAPE, m_fill, and NO_FILL.

Referenced by SetFilled().

◆ SetFillMode()

void EDA_SHAPE::SetFillMode ( FILL_T aFill )

inherited

Definition at line 570 of file eda_shape.cpp.

References m_fill, and m_hatchingDirty.

Referenced by SCH_IO_ALTIUM::AddLibTextBox(), SCH_IO_ALTIUM::AddTextBox(), SCH_EDIT_TABLE_TOOL::copyCell(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_IO_LTSPICE_PARSER::CreateRect(), fixupSchFillMode(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadPolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadRect(), SCH_IO_EAGLE::loadSymbolPolyLine(), SCH_IO_EAGLE::loadSymbolRectangle(), SCH_IO_EAGLE::loadSymbolWire(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), CONVERT_TOOL::makePolysFromClosedGraphics(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_KICAD_SEXPR_PARSER::parseSchTextBoxContent(), PAD::Recombine(), SCH_SHAPE_DESC::SCH_SHAPE_DESC(), SetFillModeProp(), SetLibShapeFillAndColor(), SetSchShapeFillAndColor(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetFillModeProp()

void EDA_SHAPE::SetFillModeProp ( UI_FILL_MODE aFill )

inherited

Definition at line 577 of file eda_shape.cpp.

References CROSS_HATCH, HATCH, NO_FILL, NONE, REVERSE_HATCH, SetFilled(), and SetFillMode().

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 142 of file eda_item.h.

References m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 166 of file view_item.h.

References m_forcedTransparency.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 210 of file eda_item.h.

References m_forceVisible.

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

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 360 of file board_item.cpp.

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

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

◆ SetHasSolderMask()

void PCB_SHAPE::SetHasSolderMask ( bool aVal )

inline

Definition at line 194 of file pcb_shape.h.

References m_hasSolderMask.

Referenced by PCB_SHAPE_DESC::PCB_SHAPE_DESC(), and SetLayerSet().

◆ SetHatchingDirty()

void EDA_SHAPE::SetHatchingDirty ( )

inlineinherited

Definition at line 147 of file eda_shape.h.

References m_hatchingDirty.

Referenced by SCH_POINT_EDITOR::removeCorner().

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Definition at line 320 of file board_item.h.

References m_isKnockout.

Referenced by ZONE_FILLER::addKnockout(), ALTIUM_PCB::ConvertTexts6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), MULTICHANNEL_TOOL::copyRuleAreaContents(), PCB_TEXT::Deserialize(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), PCB_TEXT_DESC::PCB_TEXT_DESC(), PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC(), and PCB_FIELDS_GRID_TABLE::SetValueAsBool().

◆ SetIsProxyItem()

void PCB_SHAPE::SetIsProxyItem ( bool aIsProxy = true )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 584 of file pcb_shape.cpp.

References DEFAULT_LINE_WIDTH, BOARD_ITEM::GetBoard(), PAD::GetLocalThermalSpokeWidthOverride(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_proxyItem, pad, pcbIUScale, SEGMENT, EDA_SHAPE::SetWidth(), and ZONE_THERMAL_RELIEF_COPPER_WIDTH_MM.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parsePAD(), PCB_IO_KICAD_SEXPR_PARSER::parsePadstack(), and PCB_SHAPE_DESC::PCB_SHAPE_DESC().

◆ SetIsRollover()

void EDA_ITEM::SetIsRollover ( bool aIsRollover )

inlineinherited

Definition at line 132 of file eda_item.h.

References m_isRollover.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 176 of file eda_item.h.

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

◆ SetLayer()

void PCB_SHAPE::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtual

Set the layer this item is on.

Parameters

aLayer The layer number.

Reimplemented from BOARD_ITEM.

Definition at line 176 of file pcb_shape.cpp.

References BOARD_ITEM::IsOnCopperLayer(), BOARD_ITEM::SetLayer(), and BOARD_CONNECTED_ITEM::SetNetCode().

Referenced by PCB_TABLE::AddCell(), PCAD2KICAD::PCAD_ARC::AddToBoard(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), ZONE_CREATE_HELPER::commitZone(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), Deserialize(), PCB_TEXTBOX::Deserialize(), DRAWING_TOOL::drawArc(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), DRAWING_TOOL::drawShape(), PAD_TOOL::explodePad(), Flip(), GENDRILL_WRITER_BASE::genDrillMapFile(), ALTIUM_PCB::HelperParsePad6NonCopper(), PCB_TABLE::InsertCell(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), PCB_IO_EAGLE::loadPlain(), FABMASTER::loadPolygon(), GRAPHICS_CLEANER::mergeRects(), EDIT_TOOL::ModifyLines(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), PCB_IO_EAGLE::packageWire(), GPCB_FPL_CACHE::parseFOOTPRINT(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), CONVERT_TOOL::SegmentToArc(), and SetLayerSet().

◆ SetLayerSet()

void PCB_SHAPE::SetLayerSet ( const LSET & aLayers )

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 247 of file pcb_shape.cpp.

References IsCopperLayer(), IsSolderMaskLayer(), LSET::RunOnLayers(), SetHasSolderMask(), and SetLayer().

◆ SetLeft()

virtual void EDA_SHAPE::SetLeft ( int val )

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 250 of file eda_shape.h.

References SetStartX().

Referenced by RECTANGLE_POINT_EDIT_BEHAVIOR::UpdateItem().

◆ SetLength()

void EDA_SHAPE::SetLength ( const double & aLength )

inherited

Definition at line 466 of file eda_shape.cpp.

References m_segmentLength, m_shape, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

◆ SetLineColor()

void EDA_SHAPE::SetLineColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 164 of file eda_shape.h.

References m_stroke.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ SetLineStyle()

void EDA_SHAPE::SetLineStyle ( const LINE_STYLE aStyle )

inherited

Definition at line 2499 of file eda_shape.cpp.

References m_stroke.

Referenced by Deserialize(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), SCH_IO_ALTIUM::ParseLine(), PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC(), and SCH_SCREEN::Plot().

◆ SetLocalRatsnestVisible()

void BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible ( bool aVisible )

inlineinherited

Definition at line 200 of file board_connected_item.h.

References m_localRatsnestVisible.

Referenced by PCB_EDIT_FRAME::ExchangeFootprint().

◆ SetLocalSolderMaskMargin()

void PCB_SHAPE::SetLocalSolderMaskMargin ( std::optional< int > aMargin )

inline

Definition at line 197 of file pcb_shape.h.

References m_solderMaskMargin.

Referenced by PCB_SHAPE_DESC::PCB_SHAPE_DESC().

◆ SetLocked()

void BOARD_ITEM::SetLocked ( bool aLocked )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in FOOTPRINT, and PCB_GROUP.

Definition at line 323 of file board_item.h.

References m_isLocked.

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

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 100 of file eda_item.cpp.

References IS_CHANGED, m_parent, and SetFlags().

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

◆ SetNet()

void BOARD_CONNECTED_ITEM::SetNet ( NETINFO_ITEM * aNetInfo )

inlineinherited

Set a NET_INFO object for the item.

Definition at line 90 of file board_connected_item.h.

References m_netinfo.

Referenced by BOOST_AUTO_TEST_CASE(), PNS_KICAD_IFACE::createBoardItem(), EDIT_TOOL::DragArcTrack(), EDIT_TOOL::FilletTracks(), ROUTER_TOOL::handleLayerSwitch(), CADSTAR_PCB_ARCHIVE_LOADER::loadCoppers(), FABMASTER::loadEtch(), CADSTAR_PCB_ARCHIVE_LOADER::loadNets(), CADSTAR_PCB_ARCHIVE_LOADER::loadTemplates(), FABMASTER::loadVias(), FABMASTER::loadZone(), main(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), PNS_KICAD_IFACE::modifyBoardItem(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

◆ SetNetCode() [1/2]

void BOARD_CONNECTED_ITEM::SetNetCode ( int aNetCode )

inlineinherited

Definition at line 120 of file board_connected_item.h.

References SetNetCode().

◆ SetNetCode() [2/2]

bool BOARD_CONNECTED_ITEM::SetNetCode	(	int	aNetCode,
		bool	aNoAssert )

inherited

Set net using a net code.

Note: Pads not on copper layers will have their net code always set to 0 (not connected).

Parameters

aNetCode	is a net code for the new net. It has to exist in NETINFO_LIST held by BOARD.
aNoAssert	if true, do not assert that the net exists. Otherwise, item is assigned to the unconnected net.

Returns: true on success, false if the net did not exist

Definition at line 73 of file board_connected_item.cpp.

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

Referenced by BOARD::AddArea(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), CN_VISITOR::checkZoneItemConnection(), TEARDROP_MANAGER::createTeardrop(), PCB_EDIT_FRAME::Edit_Zone_Params(), PCB_EDIT_FRAME::ExchangeFootprint(), ZONE_SETTINGS::ExportSetting(), MULTICHANNEL_TOOL::fixupNet(), FOOTPRINT::FOOTPRINT(), PCB_IO_EAGLE::loadPlain(), PCB_IO_EAGLE::loadSignals(), PCB_IO_KICAD_LEGACY::loadTrackList(), DSN::SPECCTRA_DB::makeARC(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), FOOTPRINT::operator=(), PAD::SetAttribute(), PCB_SHAPE::SetLayer(), SetNetCode(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), and DIALOG_PAD_PROPERTIES::transferDataToPad().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and NETINFO_ITEM.

Definition at line 113 of file eda_item.h.

References EDA_ITEM(), and m_parent.

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

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

Definition at line 115 of file eda_item.h.

References m_group.

Referenced by EDA_GROUP::AddItem(), PCB_IO_KICAD_SEXPR::FootprintSave(), GENDRILL_WRITER_BASE::genDrillMapFile(), SCH_SYMBOL::GetOrientation(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), EDA_GROUP::RemoveItem(), SaveCopyOfZones(), and CLIPBOARD_IO::SaveSelection().

◆ SetPolyPoints()

void EDA_SHAPE::SetPolyPoints ( const std::vector< VECTOR2I > & aPoints )

inherited

Definition at line 1829 of file eda_shape.cpp.

References m_poly.

Referenced by PAD::AddPrimitivePoly(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), MICROWAVE_TOOL::createPolygonShape(), ALTIUM_PCB::HelperParsePad6NonCopper(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), and scale().

◆ SetPolyShape()

void EDA_SHAPE::SetPolyShape ( const SHAPE_POLY_SET & aShape )

inlineinherited

Definition at line 345 of file eda_shape.h.

References m_poly.

Referenced by PAD::AddPrimitivePoly(), ZONE_CREATE_HELPER::commitZone(), CONVERT_TOOL::CreatePolys(), Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), TEST_EE_ITEM_FIXTURE::Instantiate(), FABMASTER::loadGraphics(), FABMASTER::loadPolygon(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), and PAD::Recombine().

◆ SetPosition()

void PCB_SHAPE::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 78 of file pcb_shape.h.

References EDA_SHAPE::setPosition().

Referenced by DRC_TEST_PROVIDER_CREEPAGE::CollectBoardEdges(), PCB_TEXTBOX::Deserialize(), DRAWING_TOOL::DrawTable(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), and PCB_TABLE::Normalize().

◆ setPosition()

void EDA_SHAPE::setPosition ( const VECTOR2I & aPos )

protectedinherited

Definition at line 367 of file eda_shape.cpp.

References getPosition(), and move.

Referenced by PCB_SHAPE::SetPosition(), and SCH_SHAPE::SetPosition().

◆ SetRadius()

void EDA_SHAPE::SetRadius ( int aX )

inlineinherited

Definition at line 240 of file eda_shape.h.

References m_end, m_hatchingDirty, and m_start.

Referenced by DRC_TEST_PROVIDER_CREEPAGE::CollectBoardEdges(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), and CIRCLE_GEOM_SYNCER::OnCenterRadiusChange().

◆ SetRectangle()

void EDA_SHAPE::SetRectangle	(	const long long int &	aHeight,
		const long long int &	aWidth )

inherited

Definition at line 510 of file eda_shape.cpp.

References m_rectangleHeight, m_rectangleWidth, m_shape, RECTANGLE, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

◆ SetRectangleHeight()

void EDA_SHAPE::SetRectangleHeight ( const int & aHeight )

inherited

Definition at line 480 of file eda_shape.cpp.

References GetStartY(), m_rectangleHeight, m_shape, RECTANGLE, SetEndY(), SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), and PCB_TABLECELL::PCB_TABLECELL().

◆ SetRectangleWidth()

void EDA_SHAPE::SetRectangleWidth ( const int & aWidth )

inherited

Definition at line 495 of file eda_shape.cpp.

References GetStartX(), m_rectangleWidth, m_shape, RECTANGLE, SetEndX(), SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), and PCB_TABLECELL::PCB_TABLECELL().

◆ SetRight()

virtual void EDA_SHAPE::SetRight ( int val )

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 251 of file eda_shape.h.

References SetEndX().

Referenced by RECTANGLE_POINT_EDIT_BEHAVIOR::UpdateItem().

◆ SetSegmentAngle()

void EDA_SHAPE::SetSegmentAngle ( const EDA_ANGLE & aAngle )

inherited

Definition at line 525 of file eda_shape.cpp.

References m_segmentAngle, m_shape, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 134 of file eda_item.h.

void PCB_SHAPE::SetStroke ( const STROKE_PARAMS & aStroke )

virtual void EDA_SHAPE::SetTop ( int val )

wxString EDA_SHAPE::ShowShape ( ) const

inherited

Definition at line 323 of file eda_shape.cpp.

References _, ARC, BEZIER, CIRCLE, IsProxyItem(), m_shape, POLY, RECTANGLE, and SEGMENT.

◆ Similarity() [1/2]

double EDA_SHAPE::Similarity ( const EDA_SHAPE & aOther ) const

inherited

Definition at line 2559 of file eda_shape.cpp.

References SHAPE_POLY_SET::CVertex(), EDA_SHAPE(), STROKE_PARAMS::GetLineStyle(), GetShape(), STROKE_PARAMS::GetWidth(), alg::longest_common_subset(), m_arcCenter, m_bezierC1, m_bezierC2, m_bezierPoints, m_end, m_fill, m_fillColor, m_poly, m_start, m_stroke, and SHAPE_POLY_SET::TotalVertices().

Referenced by PCB_SHAPE::Similarity(), and SCH_SHAPE::Similarity().

◆ Similarity() [2/2]

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

overridevirtual

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

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

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

Implements BOARD_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 891 of file pcb_shape.cpp.

References BOARD_ITEM::BOARD_ITEM(), GetLayer(), NETINFO_ITEM::GetNetCode(), EDA_ITEM::m_flags, EDA_ITEM::m_forceVisible, m_hasSolderMask, BOARD_ITEM::m_isKnockout, BOARD_ITEM::m_isLocked, BOARD_CONNECTED_ITEM::m_netinfo, m_solderMaskMargin, PCB_SHAPE(), EDA_SHAPE::Similarity(), and EDA_ITEM::Type().

◆ Sort()

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

inlinestaticinherited

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

Parameters

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

Returns: True if aLeft is less than aRight.

Definition at line 457 of file eda_item.h.

References EDA_ITEM().

◆ StyleFromSettings()

void PCB_SHAPE::StyleFromSettings ( const BOARD_DESIGN_SETTINGS & settings )

overridevirtual

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 395 of file pcb_shape.cpp.

References GetLayer(), BOARD_DESIGN_SETTINGS::GetLineThickness(), and EDA_SHAPE::m_stroke.

Referenced by PCB_TEXTBOX::StyleFromSettings().

◆ swapData()

void PCB_SHAPE::swapData ( BOARD_ITEM * aImage )

overrideprotectedvirtual

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 787 of file pcb_shape.cpp.

References BOARD_ITEM::BOARD_ITEM(), image, EDA_ITEM::m_flags, EDA_ITEM::m_forceVisible, m_hasSolderMask, BOARD_ITEM::m_isKnockout, BOARD_ITEM::m_isLocked, BOARD_ITEM::m_layer, BOARD_CONNECTED_ITEM::m_netinfo, EDA_ITEM::m_parent, m_solderMaskMargin, PCB_SHAPE(), and EDA_SHAPE::SwapShape().

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

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

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

◆ SwapShape()

void EDA_SHAPE::SwapShape ( EDA_SHAPE * aImage )

inherited

Definition at line 2265 of file eda_shape.cpp.

References EDA_SHAPE(), image, m_arcCenter, m_bezierC1, m_bezierC2, m_bezierPoints, m_cornerRadius, m_editState, m_end, m_endsSwapped, m_fill, m_fillColor, m_hatchingDirty, m_poly, m_shape, m_start, m_stroke, and SWAPITEM.

Referenced by PCB_SHAPE::swapData(), and SCH_SHAPE::swapData().

◆ TransformShapeToPolygon() [1/2]

void EDA_SHAPE::TransformShapeToPolygon	(	SHAPE_POLY_SET &	aBuffer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc,
		bool	ignoreLineWidth = false,
		bool	includeFill = false ) const

inherited

Convert the shape to a closed polygon.

Circles and arcs are approximated by segments.

Parameters

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

Definition at line 2336 of file eda_shape.cpp.

References SEG::A, SHAPE_POLY_SET::AddOutline(), ANGLE_0, SHAPE_POLY_SET::Append(), ARC, SEG::B, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CPoint(), ERROR_OUTSIDE, GetArcMid(), GetBezierC1(), GetBezierC2(), getCenter(), GetCornerRadius(), GetEnd(), GetHatching(), SHAPE_LINE_CHAIN::GetPoint(), SHAPE_LINE_CHAIN::GetPointCount(), BEZIER_POLY::GetPoly(), GetRadius(), GetRectangleHeight(), GetRectangleWidth(), GetRectCorners(), SHAPE_LINE_CHAIN::GetSegment(), GetStart(), GetWidth(), SHAPE_POLY_SET::Inflate(), IsHatchedFill(), IsPolyShapeValid(), IsProxyItem(), IsSolidFill(), m_poly, m_shape, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::PointCount(), POLY, RECTANGLE, ROUND_ALL_CORNERS, SEGMENT, SHAPE_LINE_CHAIN::SegmentCount(), SHAPE_LINE_CHAIN::SetClosed(), SHAPE_T_asString(), TransformArcToPolygon(), TransformCircleToPolygon(), TransformOvalToPolygon(), TransformRingToPolygon(), TransformRoundChamferedRectToPolygon(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::TransformShapeToPolygon(), and PCB_SHAPE::TransformShapeToPolySet().

◆ TransformShapeToPolygon() [2/2]

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

overridevirtual

Convert the shape to a closed polygon.

Circles and arcs are approximated by segments.

Parameters

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

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 829 of file pcb_shape.cpp.

References EDA_SHAPE::TransformShapeToPolygon().

Referenced by FEATURES_MANAGER::AddShape(), BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), BOARD::ConvertBrdLayerToPolygonalContours(), CONVERT_TOOL::CreateLines(), FOOTPRINT::GetCoverageArea(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), and PAD::Recombine().

◆ TransformShapeToPolySet()

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

overridevirtual

Convert the item shape to a polyset.

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 838 of file pcb_shape.cpp.

References EDA_SHAPE::TransformShapeToPolygon().

Referenced by BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), 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.

◆ UnpackNet()

void BOARD_CONNECTED_ITEM::UnpackNet ( const kiapi::board::types::Net & aProto )

inherited

Assigns a net to this item from an API message.

If the net does not yet exist, it will be created.

Parameters

aProto is the protobuf message to unpack a net from

Definition at line 47 of file board_connected_item.cpp.

References BOARD_ITEM::GetBoard(), m_netinfo, and name.

Referenced by PAD::Deserialize(), PCB_ARC::Deserialize(), PCB_SHAPE::Deserialize(), PCB_TRACK::Deserialize(), PCB_VIA::Deserialize(), and ZONE::Deserialize().

◆ UpdateHatching()

void PCB_SHAPE::UpdateHatching ( ) const

overridevirtual

◆ ViewBBox()

const BOX2I PCB_SHAPE::ViewBBox ( ) const

overridevirtual

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

Returns: the current bounding box.

Reimplemented from EDA_ITEM.

Definition at line 764 of file pcb_shape.cpp.

References GetWidth(), BOX2< Vec >::Inflate(), and EDA_ITEM::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 DS_PROXY_VIEW_ITEM, EDIT_POINTS, KIGFX::ANCHOR_DEBUG, KIGFX::CONSTRUCTION_GEOM, KIGFX::ORIGIN_VIEWITEM, KIGFX::PREVIEW::ARC_ASSISTANT, KIGFX::PREVIEW::BEZIER_ASSISTANT, KIGFX::PREVIEW::RULER_ITEM, KIGFX::PREVIEW::SELECTION_AREA, KIGFX::PREVIEW::SIMPLE_OVERLAY_ITEM, KIGFX::PREVIEW::TWO_POINT_ASSISTANT, KIGFX::SNAP_INDICATOR, KIGFX::VIEW_GROUP, KIGFX::VIEW_OVERLAY, MY_DRAWING, PCB_TUNING_PATTERN, RATSNEST_VIEW_ITEM, RECT_RADIUS_TEXT_ITEM, ROUTER_PREVIEW_ITEM, ROUTER_STATUS_VIEW_ITEM, TUNING_STATUS_VIEW_ITEM, and VIEW_OVERLAY.

Definition at line 127 of file view_item.h.

References VIEW.

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

◆ ViewGetLayers()

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

overridevirtual

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 658 of file pcb_shape.cpp.

References B_Cu, B_Mask, F_Cu, F_Mask, GetLayer(), GetNetnameLayer(), BOARD_ITEM::GetParentFootprint(), BOARD_ITEM::IsLocked(), BOARD_ITEM::IsOnCopperLayer(), LAYER_LOCKED_ITEM_SHADOW, m_hasSolderMask, and BOARD_ITEM::m_layer.

◆ ViewGetLOD()

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

overridevirtual

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

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

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

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

Parameters

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

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

Reimplemented from KIGFX::VIEW_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 626 of file pcb_shape.cpp.

References B_Cu, F_Cu, KIGFX::RENDER_SETTINGS::GetHighContrast(), KIGFX::VIEW::GetPainter(), BOARD_ITEM::GetParentFootprint(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), KIGFX::PCB_PAINTER::GetSettings(), KIGFX::VIEW::IsLayerVisible(), LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, LAYER_LOCKED_ITEM_SHADOW, KIGFX::VIEW_ITEM::LOD_HIDE, KIGFX::VIEW_ITEM::LOD_SHOW, and BOARD_ITEM::m_layer.

◆ viewPrivData()

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

inlineinherited

◆ Visit()

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

virtualinherited

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

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

Parameters

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

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

Reimplemented in BOARD, FOOTPRINT, GBR_LAYOUT, GERBER_DRAW_ITEM, GERBER_FILE_IMAGE, LIB_SYMBOL, PCB_GROUP, PCB_TABLE, PCB_TRACK, SCH_GROUP, SCH_LABEL_BASE, SCH_SHEET, SCH_SYMBOL, and SCH_TABLE.

Definition at line 127 of file eda_item.cpp.

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

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

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 143 of file eda_item.h.

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

Member Data Documentation

◆ LOD_HIDE

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

staticconstexprprotectedinherited

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

Definition at line 180 of file view_item.h.

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

◆ LOD_SHOW

double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 210 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 530 of file eda_item.h.

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

◆ m_group

EDA_GROUP* EDA_ITEM::m_group

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Owner.

Definition at line 528 of file eda_item.h.

SHAPE_T EDA_SHAPE::m_shape

protectedinherited

◆ m_solderMaskMargin

std::optional<int> PCB_SHAPE::m_solderMaskMargin

protected

Definition at line 220 of file pcb_shape.h.

Referenced by GetLocalSolderMaskMargin(), GetSolderMaskExpansion(), operator==(), SetLocalSolderMaskMargin(), Similarity(), and swapData().

◆ m_start

VECTOR2I EDA_SHAPE::m_start

protectedinherited

◆ m_stroke

STROKE_PARAMS EDA_SHAPE::m_stroke

protectedinherited

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

See comment near SetType() regarding virtual functions.

Definition at line 524 of file eda_item.h.

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

◆ m_teardropParams

TEARDROP_PARAMETERS BOARD_CONNECTED_ITEM::m_teardropParams

protectedinherited

Not all BOARD_CONNECTED_ITEMs support teardrops, but we want those that do to share a single section in the property inspector.

Definition at line 239 of file board_connected_item.h.

Referenced by GetTeardropAllowSpanTwoTracks(), GetTeardropBestLengthRatio(), GetTeardropBestWidthRatio(), GetTeardropCurved(), GetTeardropMaxLength(), GetTeardropMaxTrackWidth(), GetTeardropMaxWidth(), GetTeardropParams(), GetTeardropParams(), GetTeardropPreferZoneConnections(), GetTeardropsEnabled(), PAD::ImportSettingsFrom(), SetTeardropAllowSpanTwoTracks(), SetTeardropBestLengthRatio(), SetTeardropBestWidthRatio(), SetTeardropCurved(), SetTeardropMaxLength(), SetTeardropMaxTrackWidth(), SetTeardropMaxWidth(), SetTeardropPreferZoneConnections(), and SetTeardropsEnabled().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 516 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 209 of file view_item.h.

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

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

Definition at line 181 of file board_item.h.

Referenced by BOARD::GetPosition().

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

Classes

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_SHAPE() [1/2]

◆ PCB_SHAPE() [2/2]

◆ ~PCB_SHAPE()

Member Function Documentation

◆ beginEdit()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ buildBezierToSegmentsPointsList()

◆ CalcArcAngles()

◆ calcEdit()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Compare()

◆ computeArcBBox()

◆ continueEdit()

◆ CopyFrom()

◆ DeleteStructure()

◆ Deserialize()

◆ Duplicate()

◆ DupPolyPointsList()

◆ endEdit()

◆ EndsSwapped()

◆ findParent()

◆ Flip()

◆ flip()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetArcAngle()

◆ GetArcMid()

◆ GetBezierC1()

◆ GetBezierC2()

◆ GetBezierPoints()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBotRight()

◆ GetBoundingBox()

◆ getBoundingBox()

◆ GetCenter()

◆ getCenter()

◆ GetClass()

◆ GetClearanceOverrides()

◆ GetConnectionPoints()

◆ GetCornerRadius()

◆ GetCorners()

◆ GetCornersInSequence()

◆ GetDisplayNetname()

◆ getDrawRotation()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveNetClass()

◆ GetEffectiveShape()

◆ GetEffectiveWidth()

◆ GetEmbeddedFiles()

◆ GetEmbeddedFonts()

◆ GetEnd()

◆ GetEndX()

◆ GetEndY()

◆ GetFillColor()