#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

EDA_ITEM *	AsEdaItem () 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.

void	BeginEdit (const VECTOR2I &aStartPoint)

bool	ContinueEdit (const VECTOR2I &aPosition)

void	CalcEdit (const VECTOR2I &aPosition)

void	EndEdit (bool aClosed=true)

void	SetEditState (int aState)

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

void	SetArcAngle (const EDA_ANGLE &aAngle) override

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 &aSettings, bool aCheckSide) 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, DRC_CONSTRAINT_T aUsage=NULL_CONSTRAINT) 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.

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

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

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	SetStart (const VECTOR2I &aStart) override

void	SetEnd (const VECTOR2I &aEnd) override

void	SetCenter (const VECTOR2I &aCenter) override

void	SetCornerRadius (int aCornerRadius) override

void	SetWidth (int aWidth) override

void	SetLibStrokeWidth (int aWidth)

void	SetShape (SHAPE_T aShape) override

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

void	SetBezierC1 (const VECTOR2I &aPt) override

void	SetBezierC2 (const VECTOR2I &aPt) override

void	SetPolyShape (const SHAPE_POLY_SET &aShape) override

void	SetEllipseCenter (const VECTOR2I &aPt) override

void	SetEllipseMajorRadius (int aR) override

void	SetEllipseMinorRadius (int aR) override

void	SetEllipseRotation (const EDA_ANGLE &aA) override

void	SetEllipseStartAngle (const EDA_ANGLE &aA) override

void	SetEllipseEndAngle (const EDA_ANGLE &aA) override

VECTOR2I	GetLibraryStart () const

VECTOR2I	GetLibraryEnd () const

SHAPE_T	GetLibraryShape () const

int	GetLibraryCornerRadius () const

VECTOR2I	GetLibraryEllipseCenter () const

int	GetLibraryEllipseMajorRadius () const

int	GetLibraryEllipseMinorRadius () const

EDA_ANGLE	GetLibraryEllipseRotation () const

EDA_ANGLE	GetLibraryEllipseStartAngle () const

EDA_ANGLE	GetLibraryEllipseEndAngle () const

void	SetLibraryEllipse (const VECTOR2I &aCenter, int aMajor, int aMinor, const EDA_ANGLE &aRotation, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aEndAngle)

VECTOR2I	GetLibraryArcMid () const

VECTOR2I	GetLibraryBezierC1 () const

VECTOR2I	GetLibraryBezierC2 () const

SHAPE_POLY_SET	GetLibraryPolyShape () const

void	RebakeFromLib ()

void	RebakeWithScale (double aScaleX, double aScaleY)

void	OverrideLibCoords (const VECTOR2I &aStart, const VECTOR2I &aEnd, const VECTOR2I &aArcMid=VECTOR2I(0, 0))

void	OverrideLibCornerRadius (int aCornerRadius)

void	OverrideLibBezier (const VECTOR2I &aC1, const VECTOR2I &aC2)

void	OverrideLibPoly (const SHAPE_POLY_SET &aPoly)

const SHAPE_POLY_SET &	GetLibPoly () const

void	Scale (double aScale)

void	UpdateHatching () const override

double	GetCoverageArea (int aTextMargin) const override
	Return the board area this item covers, used to rank candidates under the cursor so a click on a small item inside a large one selects the small one.

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, KIGFX::RENDER_SETTINGS *aRenderSettings=nullptr) 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
	Return the all the layers within the VIEW the object is painted on.

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 NETINFO_ITEM object for a given item.

virtual 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

virtual 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 (PCB_LAYER_ID aLayer=UNDEFINED_LAYER, DRC_CONSTRAINT_T aUsage=NULL_CONSTRAINT) 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

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

void	ResetUuidDirect ()

void	SetUuid (const KIID &aUuid)

void	ResetUuid ()

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

VECTOR2I	GetFPRelativePosition () const

void	SetFPRelativePosition (const VECTOR2I &aPos)

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

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

const KIFONT::METRICS &	GetFontMetrics () const

PCB_LAYER_ID	GetFlippedLayer (PCB_LAYER_ID aLayer) const
	Return the layer paired with aLayer on the opposite side of the board.

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

bool	IsIndexedInBoard () const

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.

wxString	GetLayerName (PCB_LAYER_ID aLayer) const
	Return the name of a PCB layer using the owning board's layer names when available.

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

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

KICAD_T	Type () const
	Returns the type of object.

virtual void	SetParent (EDA_ITEM *aParent)

virtual void	SetParentGroup (EDA_GROUP *aGroup)

virtual EDA_GROUP *	GetParentGroup () const

KIID	GetParentGroupId () const

bool	HasSelectedAncestorGroup () const

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

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

void	SetNetHighlighted (bool aHighlighted)

bool	IsRollover () const

VECTOR2I	GetRolloverPos () const

void	SetIsRollover (bool aIsRollover, const VECTOR2I &aMousePos)

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

virtual void	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

virtual void	ClearTempFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

bool	IsForceVisible () const

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

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

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

bool	HasCustomProperties () const

void	ClearCustomProperties ()

void	RemoveCustomProperty (const wxString &aKey)

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

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

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

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

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

virtual INSPECT_RESULT	Visit (INSPECTOR aInspector, void *aTestData, 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 wxString	DisambiguateItemDescription (UNITS_PROVIDER *aUnitsProvider, bool aFull) const

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)

void	Serialize (google::protobuf::Any &aContainer, const EDA_IU_SCALE &aScale) const

void	Serialize (kiapi::common::types::GraphicShape &aOutput, const EDA_IU_SCALE &aScale) const

bool	Deserialize (const google::protobuf::Any &aContainer, const EDA_IU_SCALE &aScale)

bool	Deserialize (const kiapi::common::types::GraphicShape &aInput, const EDA_IU_SCALE &aScale)

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

const std::vector< SEG > &	GetHatchLines () const

bool	IsClosed () const

COLOR4D	GetFillColor () const

void	SetFillColor (const COLOR4D &aColor)

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

SHAPE_T	GetShape () const

const LINE_ENDING &	GetStartEnding () const

void	SetStartEnding (const LINE_ENDING &aEnding)

const LINE_ENDING &	GetEndEnding () const

void	SetEndEnding (const LINE_ENDING &aEnding)

LINE_ENDING_STYLE	GetStartEndingStyle () const

void	SetStartEndingStyle (LINE_ENDING_STYLE aStyle)

LINE_ENDING_STYLE	GetEndEndingStyle () const

void	SetEndEndingStyle (LINE_ENDING_STYLE aStyle)

int	GetStartEndingLength () const

void	SetStartEndingLength (int aLength)

int	GetStartEndingWidth () const

void	SetStartEndingWidth (int aWidth)

int	GetEndEndingLength () const

void	SetEndEndingLength (int aLength)

int	GetEndEndingWidth () const

void	SetEndEndingWidth (int aWidth)

int	GetStartEndingStrokeWidth () const

void	SetStartEndingStrokeWidth (int aWidth)

int	GetEndEndingStrokeWidth () const

void	SetEndEndingStrokeWidth (int aWidth)

void	GetEndingTangents (EDA_ANGLE &aStartTangent, EDA_ANGLE &aEndTangent, int aLineWidth=0) const
	Compute outward-facing tangent angles at the start and end of the shape.

bool	GetLineEndingEndpoints (VECTOR2I &aStartPoint, VECTOR2I &aEndPoint) const
	Return the source endpoints used to place line endings.

bool	ShortenArcForEndings (EDA_ANGLE &aStartAngle, EDA_ANGLE &aArcAngle, double aRadius, int aLineWidth) const
	Shorten an arc body for line endings.

std::optional< BEZIER< double > >	ShortenedBezierCurve (int aLineWidth) const
	Return the cubic Bezier curve shortened for line endings.

std::vector< VECTOR2D >	ShortenedBezierPolyline (int aLineWidth) const
	Return the flattened Bezier polyline after line-ending shortening.

bool	ShortenPolyForEndings (VECTOR2D &aFirst, VECTOR2D &aLast, const VECTOR2D &aSecond, const VECTOR2D &aPenultimate, int aLineWidth) const

bool	ShortenBodyPolyPoints (std::vector< VECTOR2I > &aPoints, int aOutlineIdx, int aLineWidth) const
	Apply line-ending body shortening to copied/generated polyline points.

bool	GetShortenedBodyPolyPoints (const SHAPE_LINE_CHAIN &aOutline, int aOutlineIdx, std::vector< VECTOR2I > &aPoints, int aLineWidth) const
	Copy an outline and apply line-ending body shortening when applicable.

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

int	GetStartY () const

int	GetStartX () const

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

const VECTOR2I &	GetBezierC1 () const

const VECTOR2I &	GetBezierC2 () const

const VECTOR2I &	GetEllipseCenter () const

int	GetEllipseMajorRadius () const

int	GetEllipseMinorRadius () const

EDA_ANGLE	GetEllipseRotation () const

EDA_ANGLE	GetEllipseStartAngle () const

EDA_ANGLE	GetEllipseEndAngle () const

const ELLIPSE< int > &	GetEllipse () const
	Direct read-only access to the underlying ellipse payload.

VECTOR2I	getCenter () const

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

virtual 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	SetArcOrSegment (const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd)
	Set the shape from three points, falling back to a SEGMENT from aStart to aEnd when the points are collinear and so have no finite arc center.

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

std::vector< VECTOR2I >	GetPolyPoints () const
	Duplicate the polygon outlines into a flat list of VECTOR2I points.

int	GetPointCount () const

SHAPE_POLY_SET &	GetPolyShape ()

const SHAPE_POLY_SET &	GetPolyShape () const

bool	IsPolyShapeValid () const

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.

void	RebuildBezierToSegmentsPointsList ()

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

std::vector< SHAPE * >	MakeLineEndingEffectiveShapes (int aLineWidth) const
	Make the line-ending geometry associated with this shape.

std::vector< SHAPE * >	MakeEffectiveShapesWithLineEndings (int aLineWidth) const
	Make effective geometry for the shape body shortened for line endings plus the line-ending geometry itself.

virtual std::vector< SHAPE * >	MakeEffectiveShapesForHitTesting () const

std::vector< SHAPE * >	MakeEffectiveShapesForStroking (int aLineWidth=-1) const
	Make a set of SHAPE objects to hand to STROKE_PARAMS::Stroke().

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

void	SetRectangleHeight (const int &aHeight)

void	SetRectangleWidth (const int &aWidth)

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

int	GetCornerRadius () const

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.

void	TransformLineEndingsToPolygon (SHAPE_POLY_SET &aBuffer, int aClearance, int aError, ERROR_LOC aErrorLoc, int aLineWidth) const
	Append only the line-ending geometry associated with this shape to a polygon set.

void	TransformWithLineEndingsToPolygon (SHAPE_POLY_SET &aBuffer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const
	Convert the shape body shortened for line endings plus line-ending geometry to polygons.

bool	GetLineEndingsBoundingBox (BOX2I &aBBox, int aLineWidth) const

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.

static bool	ShortenSegmentForEndings (VECTOR2I &aStart, VECTOR2I &aEnd, const LINE_ENDING &aStartEnding, const LINE_ENDING &aEndEnding, int aLineWidth)
	Shorten a segment body for line endings.

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

virtual void	syncLibCoords ()

const FOOTPRINT *	transformFp () const

void	rebakeFromTransform (const TRANSFORM_TRS &aXform)

int	getMaxError () const override

SHAPE_POLY_SET	getHatchingKnockouts () const override

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

EDA_ITEM *	findParent (KICAD_T aType) const

wxString	getFriendlyName (FRAME_T aFrameType) 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, bool aHittesting=false) const
	Make a set of SHAPE objects representing the EDA_SHAPE.

std::vector< SHAPE * >	makeShortenedBodyShapes (int aLineWidth, bool aEdgeOnly=false) const
	Make effective geometry for the shape body shortened for line endings, without the line-ending geometry itself.

SHAPE_ELLIPSE	buildShapeEllipse () const

void	recalcEllipseArcEndpoints ()
	When m_shape == ELLIPSE_ARC, recompute m_start/m_end from m_ellipse.

SHAPE_POLY_SET &	hatching () const

std::vector< SEG > &	hatchLines () const

Static Protected Member Functions
static double	polygonArea (SHAPE_POLY_SET &aPolySet)
	Area of aPolySet with every contour closed first, holes subtracted.

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

VECTOR2I	m_libStart

VECTOR2I	m_libEnd

int	m_libCornerRadius

VECTOR2I	m_libArcMid

VECTOR2I	m_libBezierC1

VECTOR2I	m_libBezierC2

SHAPE_POLY_SET	m_libPoly

VECTOR2I	m_libEllipseCenter

int	m_libEllipseMajorRadius

int	m_libEllipseMinorRadius

EDA_ANGLE	m_libEllipseRotation

EDA_ANGLE	m_libEllipseStartAngle

EDA_ANGLE	m_libEllipseEndAngle

SHAPE_T	m_libShape

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

BOARD_ITEM_INDEX *	m_owningIndex = nullptr
	Board index that indexes this item, or nullptr.

EDA_ITEM_FLAGS	m_flags

EDA_ITEM *	m_parent
	Owner.

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

VECTOR2I	m_rolloverPos

bool	m_isRollover

bool	m_forceVisible

bool	m_netHighlighted = false

std::map< wxString, wxString >	m_customProperties

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

bool	m_endsSwapped

SHAPE_T	m_shape

STROKE_PARAMS	m_stroke

LINE_ENDING	m_startEnding

LINE_ENDING	m_endEnding

LINE_ENDING	m_blankEnding

FILL_T	m_fill

COLOR4D	m_fillColor

std::unique_ptr< EDA_SHAPE_HATCH_CACHE_DATA >	m_hatchingCache

bool	m_hatchingDirty

long long int	m_rectangleHeight

long long int	m_rectangleWidth

int	m_cornerRadius

VECTOR2I	m_start

VECTOR2I	m_end

VECTOR2I	m_arcCenter

ARC_MID	m_arcMidData

VECTOR2I	m_bezierC1

VECTOR2I	m_bezierC2

std::vector< VECTOR2I >	m_bezierPoints

ELLIPSE< int >	m_ellipse

std::unique_ptr< 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 34 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 582 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 )

◆ PCB_SHAPE() [2/2]

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

◆ ~PCB_SHAPE()

PCB_SHAPE::~PCB_SHAPE ( )

override

Definition at line 275 of file pcb_shape.cpp.

Member Function Documentation

◆ AsEdaItem()

EDA_ITEM * PCB_SHAPE::AsEdaItem ( )

inlineoverridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 46 of file pcb_shape.h.

References EDA_ITEM::EDA_ITEM().

◆ BeginEdit()

void PCB_SHAPE::BeginEdit ( const VECTOR2I & aStartPoint )

inline

Definition at line 82 of file pcb_shape.h.

References EDA_SHAPE::beginEdit(), and syncLibCoords().

◆ beginEdit()

void EDA_SHAPE::beginEdit ( const VECTOR2I & aStartPoint )

protectedinherited

◆ BoardCopperLayerCount()

int BOARD_ITEM::BoardCopperLayerCount ( ) const

virtualinherited

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

Definition at line 218 of file board_item.cpp.

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

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

◆ BoardLayerCount()

int BOARD_ITEM::BoardLayerCount ( ) const

virtualinherited

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

Definition at line 207 of file board_item.cpp.

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

◆ BoardLayerSet()

LSET BOARD_ITEM::BoardLayerSet ( ) const

virtualinherited

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

Definition at line 229 of file board_item.cpp.

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

Referenced by ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper().

◆ buildBezierToSegmentsPointsList()

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

protectedinherited

Definition at line 1226 of file eda_shape.cpp.

References BEZIER_POLY::GetPoly(), m_bezierC1, m_bezierC2, m_end, and m_start.

Referenced by makeEffectiveShapes(), MakeEffectiveShapesForStroking(), and RebuildBezierToSegmentsPointsList().

◆ buildShapeEllipse()

SHAPE_ELLIPSE EDA_SHAPE::buildShapeEllipse ( ) const

protectedinherited

Definition at line 1239 of file eda_shape.cpp.

References ELLIPSE_ARC, m_ellipse, and m_shape.

Referenced by getBoundingBox(), GetLength(), hitTest(), hitTest(), makeEffectiveShapes(), MakeEffectiveShapesForStroking(), makeShortenedBodyShapes(), SCH_SHAPE::Plot(), TransformShapeToPolygon(), TransformWithLineEndingsToPolygon(), and UpdateHatching().

◆ CalcArcAngles()

void EDA_SHAPE::CalcArcAngles	(	EDA_ANGLE &	aStartAngle,
		EDA_ANGLE &	aEndAngle ) const

inherited

Calc arc start and end angles such that aStartAngle < aEndAngle.

Each may be between -360.0 and 360.0.

Definition at line 1364 of file eda_shape.cpp.

References ANGLE_360, getCenter(), GetEnd(), and GetStart().

Referenced by CREEPAGE_GRAPH::Addshape(), BOARD_ADAPTER::addShape(), computeArcBBox(), KIGFX::PCB_PAINTER::draw(), GetArcAngle(), hitTest(), makeShortenedBodyShapes(), BRDITEMS_PLOTTER::PlotShape(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveArc(), SegmentIntersectsBoard(), CREEPAGE_GRAPH::TransformEdgeToCreepShapes(), and TransformWithLineEndingsToPolygon().

◆ CalcEdit()

void PCB_SHAPE::CalcEdit ( const VECTOR2I & aPosition )

inline

Definition at line 95 of file pcb_shape.h.

References EDA_SHAPE::calcEdit(), and syncLibCoords().

Referenced by DRAWING_TOOL::drawShape().

◆ calcEdit()

void EDA_SHAPE::calcEdit ( const VECTOR2I & aPosition )

protectedinherited

Definition at line 3205 of file eda_shape.cpp.

References std::abs(), ANGLE_0, ANGLE_180, ANGLE_360, ANGLE_90, ARC, BEZIER, center, CIRCLE, EDA_ANGLE::Cos(), VECTOR2< T >::Distance(), ELLIPSE, ELLIPSE_ARC, GetArcAngle(), GetEnd(), getMaxError(), GetPointCount(), GetPolyShape(), GetRadius(), GetShape(), GetStart(), IsStraightArc(), KiROUND(), m_arcCenter, m_editState, m_ellipse, m_end, m_start, SHAPE_POLY_SET::Outline(), POLY, RADIANS_T, radius, RebuildBezierToSegmentsPointsList(), RECTANGLE, SEGMENT, SetArcGeometry(), SetBezierC1(), SetBezierC2(), SetEllipseCenter(), SetEllipseEndAngle(), SetEllipseMajorRadius(), SetEllipseMinorRadius(), SetEllipseRotation(), SetEllipseStartAngle(), SetEnd(), SHAPE_LINE_CHAIN::SetPoint(), SetStart(), SHAPE_T_asString(), EDA_ANGLE::Sin(), sq, VECTOR2< T >::SquaredEuclideanNorm(), UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ ClassOf()

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

inlinestatic

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

References BRIGHTENED, and ClearFlags().

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

◆ ClearCustomProperties()

void EDA_ITEM::ClearCustomProperties ( )

inlineinherited

Definition at line 270 of file eda_item.h.

References m_customProperties.

Referenced by dropCustomProperties(), dropCustomProperties(), dropCustomPropertiesFp(), dropSymbolCustomProperties(), and lineEndingPolygons().

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 178 of file eda_item.h.

References ClearFlags(), and GetEditFlags().

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 160 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, m_flags, and m_netHighlighted.

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

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 191 of file eda_item.h.

References ClearFlags(), and GetTempFlags().

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

◆ Clone()

EDA_ITEM * PCB_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 1789 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

◆ computeArcBBox()

void EDA_SHAPE::computeArcBBox ( BOX2I & aBBox ) const

protectedinherited

Definition at line 2272 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 PCB_SHAPE::ContinueEdit ( const VECTOR2I & aPosition )

inline

Definition at line 88 of file pcb_shape.h.

References EDA_SHAPE::continueEdit(), result, and syncLibCoords().

Referenced by DRAWING_TOOL::drawShape().

◆ continueEdit()

bool EDA_SHAPE::continueEdit ( const VECTOR2I & aPosition )

protectedinherited

Definition at line 3165 of file eda_shape.cpp.

References SHAPE_LINE_CHAIN::Append(), ARC, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), ELLIPSE, ELLIPSE_ARC, SHAPE_LINE_CHAIN::GetPointCount(), GetPolyShape(), GetShape(), m_editState, SHAPE_POLY_SET::Outline(), POLY, RECTANGLE, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

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

◆ CopyFrom()

void PCB_SHAPE::CopyFrom ( const BOARD_ITEM * aOther )

overridevirtual

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

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

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

◆ Deserialize() [1/3]

bool EDA_SHAPE::Deserialize	(	const google::protobuf::Any &	aContainer,
		const EDA_IU_SCALE &	aScale )

inherited

Definition at line 466 of file eda_shape.cpp.

References Deserialize().

◆ Deserialize() [2/3]

bool EDA_SHAPE::Deserialize	(	const kiapi::common::types::GraphicShape &	aInput,
		const EDA_IU_SCALE &	aScale )

inherited

Definition at line 369 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, DEGREES_T, ELLIPSE, ELLIPSE_ARC, FromProtoEnum(), getMaxError(), m_arcCenter, m_arcMidData, m_bezierC1, m_bezierC2, m_editState, m_end, m_endEnding, m_endsSwapped, m_fillColor, m_proxyItem, m_start, m_startEnding, m_stroke, POLY, RebuildBezierToSegmentsPointsList(), RECTANGLE, SEGMENT, SetArcGeometry(), SetBezierC1(), SetBezierC2(), SetCornerRadius(), SetEllipseCenter(), SetEllipseEndAngle(), SetEllipseMajorRadius(), SetEllipseMinorRadius(), SetEllipseRotation(), SetEllipseStartAngle(), SetEnd(), SetFillColor(), SetFillMode(), SetPolyShape(), SetShape(), SetStart(), kiapi::common::UnpackColor(), kiapi::common::UnpackDistance(), kiapi::common::UnpackLineEnding(), kiapi::common::UnpackPolySet(), kiapi::common::UnpackStroke(), kiapi::common::UnpackVector2(), and COLOR4D::UNSPECIFIED.

◆ Deserialize() [3/3]

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_TABLECELL, and PCB_TEXTBOX.

Definition at line 331 of file pcb_shape.cpp.

References EDA_SHAPE::Deserialize(), FromProtoEnum(), EDA_SHAPE::GetShape(), 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, pcbIUScale, RECTANGLE, SEGMENT, SetHasSolderMask(), SetLayer(), SetLocalSolderMaskMargin(), BOARD_ITEM::SetLocked(), BOARD_ITEM::SetUuidDirect(), kiapi::common::UnpackCustomProperties(), and BOARD_CONNECTED_ITEM::UnpackNet().

Referenced by BOOST_AUTO_TEST_CASE().

◆ DisambiguateItemDescription()

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

inlinevirtualinherited

Reimplemented in FOOTPRINT.

Definition at line 458 of file eda_item.h.

References GetItemDescription().

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ Duplicate()

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

virtualinherited

Create a copy of this BOARD_ITEM.

Parameters

addToParentGroup	Indicates whether or not the new item is added to the group containing the old item. If true, aCommit must be provided.
aCommit	is the commit object for undo/redo.

Reimplemented in FOOTPRINT, PCB_TABLE, and ZONE.

Definition at line 375 of file board_item.cpp.

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

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

◆ EndEdit()

void PCB_SHAPE::EndEdit ( bool aClosed = true )

inline

Definition at line 101 of file pcb_shape.h.

References EDA_SHAPE::endEdit(), and syncLibCoords().

Referenced by DRAWING_TOOL::drawShape().

◆ 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 3487 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), ELLIPSE, ELLIPSE_ARC, SHAPE_LINE_CHAIN::GetPointCount(), GetPolyShape(), GetShape(), m_editState, SHAPE_POLY_SET::Outline(), POLY, recalcEllipseArcEndpoints(), RECTANGLE, SHAPE_LINE_CHAIN::Remove(), SEGMENT, SHAPE_LINE_CHAIN::SetClosed(), SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::EndEdit(), and 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 460 of file eda_shape.h.

References m_endsSwapped.

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

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 137 of file eda_item.cpp.

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

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

◆ FitsEnabledLayers()

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

virtualinherited

Check if a board offering aEnabledLayers can hold this item.

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

Reimplemented in FOOTPRINT, and PCB_VIA.

Definition at line 40 of file board_item.cpp.

References GetLayerSet(), and IsLayerAgnostic().

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

◆ 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 910 of file pcb_shape.cpp.

References ANGLE_180, ARC, BEZIER, BOARD_ITEM::BOARD_ITEM(), CIRCLE, ELLIPSE, ELLIPSE_ARC, EDA_SHAPE::flip(), BOARD_ITEM::GetFlippedLayer(), GetLayer(), BOARD_ITEM::GetParent(), FOOTPRINT::GetTransform(), TRANSFORM_TRS::InverseApply(), LEFT_RIGHT, m_libArcMid, m_libBezierC1, m_libBezierC2, m_libEllipseCenter, m_libEllipseEndAngle, m_libEllipseRotation, m_libEllipseStartAngle, m_libEnd, m_libPoly, m_libShape, m_libStart, EDA_SHAPE::m_shape, PCB_PAD_T, POLY, rebakeFromTransform(), RECTANGLE, SEGMENT, SetLayer(), TRANSFORM_TRS::SetScale(), syncLibCoords(), transformFp(), EDA_ITEM::Type(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ flip()

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

protectedinherited

Definition at line 1161 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, ELLIPSE, ELLIPSE_ARC, getMaxError(), GetPolyShape(), m_arcCenter, m_bezierC1, m_bezierC2, m_ellipse, m_end, m_hatchingDirty, m_shape, m_start, MIRROR(), SHAPE_POLY_SET::Mirror(), POLY, RebuildBezierToSegmentsPointsList(), recalcEllipseArcEndpoints(), RECTANGLE, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PCB_SHAPE::Flip(), PCB_SHAPE::Mirror(), SCH_SHAPE::MirrorHorizontally(), and SCH_SHAPE::MirrorVertically().

◆ Get() [1/3]

template<typename T>

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

inherited

Definition at line 84 of file inspectable_impl.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

Definition at line 74 of file inspectable.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), MATCH_PROPERTIES_CATALOG::Copy(), KICAD_DIFF::DiffItemProperties(), PROPERTIES_PANEL::getItemValue(), PCBEXPR_VAR_REF::GetValue(), DIALOG_FIND_BY_PROPERTIES::getVariantAwareValue(), KICAD_DIFF::ItemProperties(), plan(), FOOTPRINT::ResolveTextVar(), SCH_SYMBOL::ResolveTextVar(), and SCHEMATIC::SCHEMATIC().

◆ Get() [3/3]

template<typename T>

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inherited

Definition at line 72 of file inspectable_impl.h.

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

◆ GetArcAngle()

EDA_ANGLE EDA_SHAPE::GetArcAngle ( ) const

inherited

◆ GetArcMid()

VECTOR2I EDA_SHAPE::GetArcMid ( ) const

inherited

Definition at line 1351 of file eda_shape.cpp.

References GetArcAngle(), m_arcCenter, m_arcMidData, m_end, m_start, and RotatePoint().

Referenced by PCB_GRID_HELPER::AddConstructionItems(), PCB_POINT_EDITOR::addCorner(), PAD::AddPrimitive(), ArcTangentSeedAt(), BoardItemIntersectable(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), KI_TEST::CheckFpShape(), Compare(), ConnectBoardShapes(), CONVERT_TOOL::CreateLines(), editArcMidKeepEndpoints(), PCB_WRITER_V10::format(), PCB_WRITER_V9::format(), formatArc(), formatArc(), formatArc(), PCB_SHAPE::GetConnectionPoints(), PCB_SHAPE::GetFocusPosition(), PCB_SHAPE::GetLibraryArcMid(), GRAPH_CONNECTION::GetShapes(), GraphicEditArc(), hash_fp_item(), IsClockwiseArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadArc(), CONVERT_TOOL::makePolysFromChainedSegs(), SCH_CONNECTIVITY::LIBRARY_SHAPE_FACT::operator==(), SCH_SHAPE::Plot(), processShapeSegment(), CONVERT_TOOL::SegmentToArc(), Serialize(), SetArcGeometry(), PCB_SHAPE::syncLibCoords(), tangentAtEndpoint(), PLOTTER::ThickArc(), CREEPAGE_GRAPH::TransformEdgeToCreepShapes(), TransformShapeToPolygon(), and ARC_GEOM_SYNCER::updateSME().

◆ GetBezierC1()

const VECTOR2I & EDA_SHAPE::GetBezierC1 ( ) const

inlineinherited

◆ GetBezierC2()

const VECTOR2I & EDA_SHAPE::GetBezierC2 ( ) const

inlineinherited

◆ GetBezierPoints()

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

inlineinherited

Definition at line 505 of file eda_shape.h.

References m_bezierPoints.

Referenced by FEATURES_MANAGER::AddShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BuildCreepageBoardEdges(), GetEndingTangents(), GetLineEndingEndpoints(), idf_append_shape(), GRAPHICS_CLEANER::isNullShape(), makeBezierChain(), CONVERT_TOOL::makePolysFromChainedSegs(), SCH_CONNECTIVITY::LIBRARY_SHAPE_FACT::operator==(), processShapeSegment(), CONSTRAINT_OVERLAY::render(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), and GRAPHICS_IMPORTER::setupSplineOrLine().

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

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

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

◆ GetBotRight()

virtual VECTOR2I EDA_SHAPE::GetBotRight ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

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

overridevirtual

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 1806 of file pcb_shape.cpp.

References EDA_SHAPE::getBoundingBox(), EDA_SHAPE::GetEffectiveWidth(), EDA_SHAPE::GetLineEndingsBoundingBox(), BOX2< Vec >::Merge(), and BOX2< Vec >::Normalize().

Referenced by BOARD_ADAPTER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), getHatchingKnockouts(), and CREEPAGE_GRAPH::TransformEdgeToCreepShapes().

◆ getBoundingBox()

const BOX2I EDA_SHAPE::getBoundingBox ( ) const

protectedinherited

Definition at line 1624 of file eda_shape.cpp.

References ARC, SHAPE_ELLIPSE::BBox(), BEZIER, buildShapeEllipse(), CIRCLE, computeArcBBox(), ELLIPSE, ELLIPSE_ARC, GetEnd(), GetPolyShape(), GetRadius(), GetRectCorners(), GetStart(), GetWidth(), BOX2< Vec >::Inflate(), m_bezierPoints, 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(), hitTest(), and TransformShapeToPolygon().

◆ 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 80 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(), BoardItemIntersectable(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), buildCarrier(), KI_TEST::CheckFpShape(), constraintMemberForEditPoint(), ConstraintShapeAnchors(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_SELECTION_TOOL::extendTableCellSelectionTo(), GENCAD_EXPORTER::footprintWriteShape(), GetConnectionPoints(), GetFocusPosition(), hash_fp_item(), hashShape(), idf_append_shape(), RECTANGLE_POINT_EDIT_BEHAVIOR::MakePoints(), CONVERT_TOOL::makePolysFromClosedGraphics(), KICAD_FORMAT::LEGACY::orderFpShapes(), outlineProximity(), PCB_IO_EAGLE::packageRectangle(), BRDITEMS_PLOTTER::PlotShape(), processClosedShape(), OUTSET_ROUTINE::ProcessItem(), POLYGON_BOOLEAN_ROUTINE::ProcessShape(), CONSTRAINT_OVERLAY::render(), EDIT_TOOL::Rotate(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), SegmentIntersectsBoard(), AR_MATRIX::TracePcbShape(), CREEPAGE_GRAPH::TransformEdgeToCreepShapes(), PCB_TEXTBOX::TransformTextToPolySet(), CREEPAGE_OVERLAY::Update(), CIRCLE_GEOM_SYNCER::updateCenterPoint(), CIRCLE_GEOM_SYNCER::updateCenterRadius(), RECTANGLE_GEOM_SYNCER::updateCenterSize(), ARC_GEOM_SYNCER::updateCRAA(), ARC_GEOM_SYNCER::updateCSA(), PCB_POINT_EDITOR::updateItem(), RECTANGLE_POINT_EDIT_BEHAVIOR::UpdatePoints(), and LINE_GEOM_SYNCER::updateStartMidpoint().

◆ getCenter()

VECTOR2I EDA_SHAPE::getCenter ( ) const

inherited

Definition at line 1290 of file eda_shape.cpp.

References ARC, BEZIER, BOX2< Vec >::Centre(), CIRCLE, ELLIPSE, ELLIPSE_ARC, getBoundingBox(), m_arcCenter, m_ellipse, 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(), GetEndingTangents(), getPosition(), hitTest(), hitTest(), makeEffectiveShapes(), SCH_SHAPE::Plot(), tangentAtEndpoint(), 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 55 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 169 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 533 of file pcb_shape.cpp.

References ARC, EDA_ANGLE::AsRadians(), BEZIER, CIRCLE, circle(), ELLIPSE, ELLIPSE_ARC, EDA_SHAPE::GetArcMid(), GetCenter(), KIGEOM::GetCircleKeyPoints(), EDA_SHAPE::GetEllipseCenter(), EDA_SHAPE::GetEllipseEndAngle(), EDA_SHAPE::GetEllipseMajorRadius(), EDA_SHAPE::GetEllipseMinorRadius(), EDA_SHAPE::GetEllipseRotation(), EDA_SHAPE::GetEllipseStartAngle(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::IsSolidFill(), KI_FALLTHROUGH, KiROUND(), M_PI, 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(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), and DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer().

◆ GetCornerRadius()

int EDA_SHAPE::GetCornerRadius ( ) const

inherited

Definition at line 605 of file eda_shape.cpp.

References m_cornerRadius.

Referenced by BOARD_ADAPTER::addShape(), PCB_IO_IPC2581::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), CONVERT_TOOL::CreateLines(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), FabMaskShape(), PCB_IO_KICAD_SEXPR::format(), PCB_WRITER_V10::format(), formatRect(), formatRect(), isRoundedRect(), isRoundedRect(), RECTANGLE_POINT_EDIT_BEHAVIOR::MakePoints(), RECTANGLE_POINT_EDIT_BEHAVIOR::MakePoints(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), processClosedShape(), OUTSET_ROUTINE::ProcessItem(), roundedRectToPolygon(), roundedRectToPolygon(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SegmentIntersectsBoard(), Serialize(), PCB_IO_IPC2581::shapeHash(), PCB_SHAPE::syncLibCoords(), CREEPAGE_GRAPH::TransformEdgeToCreepShapes(), TransformShapeToPolygon(), UpdateHatching(), RECTANGLE_POINT_EDIT_BEHAVIOR::UpdatePoints(), and RECTANGLE_POINT_EDIT_BEHAVIOR::UpdatePoints().

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

Reimplemented in PCB_TEXTBOX.

Definition at line 783 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.

◆ GetCornersInSequence()

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

virtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 2133 of file eda_shape.cpp.

References ANGLE_0, ANGLE_180, ANGLE_270, ANGLE_90, center, BOX2< Vec >::GetBottom(), getBoundingBox(), BOX2< Vec >::GetCenter(), BOX2< Vec >::GetLeft(), GetPolyShape(), BOX2< Vec >::GetRight(), BOX2< Vec >::GetTop(), EDA_ANGLE::IsCardinal(), m_shape, BOX2< Vec >::Normalize(), EDA_ANGLE::Normalize(), SHAPE_POLY_SET::OutlineCount(), RECTANGLE, RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_TABLE::DrawBorders(), and PCB_TEXTBOX::GetCornersInSequence().

◆ GetCoverageArea()

double PCB_SHAPE::GetCoverageArea ( int aTextMargin ) const

overridevirtual

Return the board area this item covers, used to rank candidates under the cursor so a click on a small item inside a large one selects the small one.

Parameters

aTextMargin the margin added around text, normally the hit-test accuracy.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 1894 of file pcb_shape.cpp.

References ARC, BEZIER, CIRCLE, BOARD_ITEM::GetCoverageArea(), EDA_SHAPE::GetShape(), GetWidth(), EDA_SHAPE::IsAnyFill(), KI_FALLTHROUGH, POLY, RECTANGLE, and SEGMENT.

Referenced by BOOST_AUTO_TEST_CASE().

◆ GetCustomProperties()

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

inlineinherited

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

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

Definition at line 242 of file eda_item.h.

References m_customProperties.

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

◆ GetCustomPropertiesAsInspectables()

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

inherited

Definition at line 200 of file eda_item.cpp.

References m_customProperties, m_customPropsStorageCache, and TYPE_HASH.

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

◆ GetCustomProperty()

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

inherited

Returns: true if aKey is present and aValue was filled

Definition at line 188 of file eda_item.cpp.

References m_customProperties.

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

◆ GetDisplayNetname()

const wxString & BOARD_CONNECTED_ITEM::GetDisplayNetname ( ) const

inherited

Returns: the unescaped short netname.

Definition at line 185 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(), KIGFX::PCB_PAINTER::draw(), and PCB_TRACK::ViewGetLOD().

◆ getDrawRotation()

virtual EDA_ANGLE EDA_SHAPE::getDrawRotation ( ) const

inlineprotectedvirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 688 of file eda_shape.h.

References ANGLE_0.

◆ GetDynamicProperties()

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

overridevirtualinherited

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

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

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

Reimplemented from INSPECTABLE.

Reimplemented in FOOTPRINT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 226 of file eda_item.cpp.

References GetCustomPropertiesAsInspectables().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveHoleShape()

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

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 451 of file board_item.cpp.

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

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

◆ 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 130 of file board_connected_item.cpp.

References NETCLASS::Default, BOARD_ITEM::GetBoard(), and m_netinfo.

Referenced by PCB_TUNING_PATTERN::CreateNew(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DRAWING_TOOL::DrawVia(), PCB_TUNING_PATTERN::EditStart(), DRC_ENGINE::EvalRules(), 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(), 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,
		DRC_CONSTRAINT_T	aUsage = NULL_CONSTRAINT ) 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 1820 of file pcb_shape.cpp.

References EDA_SHAPE::GetEffectiveWidth(), GetLayer(), GetSolderMaskExpansion(), HasSolderMask(), IsCopperLayer(), IsSolderMaskLayer(), and EDA_SHAPE::MakeEffectiveShapesWithLineEndings().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), doConvertOutlineToPolygon(), PCB_TEXTBOX::GetEffectiveShape(), TestBoardOutlinesGraphicItems(), and DRC_TEST_PROVIDER_MISC::testOutline().

◆ GetEffectiveWidth()

virtual int EDA_SHAPE::GetEffectiveWidth ( ) const

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 166 of file eda_shape.h.

References GetWidth().

Referenced by PCB_SHAPE::GetBoundingBox(), PCB_SHAPE::GetEffectiveShape(), GetHatchLineWidth(), hitTest(), hitTest(), hitTest(), makeEffectiveShapes(), MakeEffectiveShapesForStroking(), makeShortenedBodyShapes(), PNS_KICAD_IFACE_BASE::syncGraphicalItem(), TransformWithLineEndingsToPolygon(), and unsafeLineEndings().

◆ GetEllipse()

const ELLIPSE< int > & EDA_SHAPE::GetEllipse ( ) const

inlineinherited

Direct read-only access to the underlying ellipse payload.

Useful for copying into a SHAPE_ELLIPSE when building effective collision shapes.

Definition at line 435 of file eda_shape.h.

References ELLIPSE, and m_ellipse.

◆ GetEllipseCenter()

const VECTOR2I & EDA_SHAPE::GetEllipseCenter ( ) const

inlineinherited

Definition at line 385 of file eda_shape.h.

References m_ellipse.

◆ GetEllipseEndAngle()

EDA_ANGLE EDA_SHAPE::GetEllipseEndAngle ( ) const

inlineinherited

Definition at line 431 of file eda_shape.h.

References m_ellipse.

◆ GetEllipseMajorRadius()

int EDA_SHAPE::GetEllipseMajorRadius ( ) const

inlineinherited

Definition at line 394 of file eda_shape.h.

References m_ellipse.

◆ GetEllipseMinorRadius()

int EDA_SHAPE::GetEllipseMinorRadius ( ) const

inlineinherited

Definition at line 403 of file eda_shape.h.

References m_ellipse.

◆ GetEllipseRotation()

EDA_ANGLE EDA_SHAPE::GetEllipseRotation ( ) const

inlineinherited

Definition at line 412 of file eda_shape.h.

References m_ellipse.

◆ GetEllipseStartAngle()

EDA_ANGLE EDA_SHAPE::GetEllipseStartAngle ( ) const

inlineinherited

Definition at line 422 of file eda_shape.h.

References m_ellipse.

◆ GetEmbeddedFiles()

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )

inlinevirtualinherited

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

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

References GetBoard().

◆ GetEnd()

const VECTOR2I & EDA_SHAPE::GetEnd ( ) const

inlineinherited

Return the ending point of the graphic.

Definition at line 333 of file eda_shape.h.

References m_end.

◆ GetEndEnding()

const LINE_ENDING & EDA_SHAPE::GetEndEnding ( ) const

inlineinherited

◆ GetEndEndingLength()

int EDA_SHAPE::GetEndEndingLength ( ) const

inlineinherited

Definition at line 202 of file eda_shape.h.

References m_endEnding.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ GetEndEndingStrokeWidth()

int EDA_SHAPE::GetEndEndingStrokeWidth ( ) const

inlineinherited

Definition at line 209 of file eda_shape.h.

References m_endEnding.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ GetEndEndingStyle()

LINE_ENDING_STYLE EDA_SHAPE::GetEndEndingStyle ( ) const

inlineinherited

Definition at line 194 of file eda_shape.h.

References m_endEnding.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), and hasLineEndings().

◆ GetEndEndingWidth()

int EDA_SHAPE::GetEndEndingWidth ( ) const

inlineinherited

Definition at line 204 of file eda_shape.h.

References m_endEnding.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ GetEndingTangents()

void EDA_SHAPE::GetEndingTangents	(	EDA_ANGLE &	aStartTangent,
		EDA_ANGLE &	aEndTangent,
		int	aLineWidth = 0 ) const

inherited

Compute outward-facing tangent angles at the start and end of the shape.

When aLineWidth > 0, the tangent accounts for line shortening so that end shapes align with the visible stroke on tight curves.

Definition at line 4057 of file eda_shape.cpp.

References ANGLE_0, ANGLE_180, ANGLE_90, ARC, ARROW_OPEN, BEZIER, bezierLength(), SHAPE_LINE_CHAIN::CPoint(), delta, ELLIPSE_ARC, VECTOR2< T >::EuclideanNorm(), findBezierTAtLength(), GetBezierC1(), GetBezierC2(), GetBezierPoints(), getCenter(), LINE_ENDING::GetCurveOrientationDepth(), GetEnd(), GetPolyShape(), GetStart(), LINE_ENDING::GetStyle(), m_bezierC1, m_bezierC2, m_ellipse, m_end, m_endEnding, m_shape, m_start, m_startEnding, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::PointCount(), POLY, SEGMENT, and ShortenedBezierCurve().

Referenced by BOARD_ADAPTER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EXPORTER_STEP::buildGraphic3DShape(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), GetLineEndingsBoundingBox(), MakeLineEndingEffectiveShapes(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), and TransformLineEndingsToPolygon().

◆ GetEndX()

int EDA_SHAPE::GetEndX ( ) const

inlineinherited

Definition at line 335 of file eda_shape.h.

References m_end.

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

◆ GetEndY()

int EDA_SHAPE::GetEndY ( ) const

inlineinherited

Definition at line 334 of file eda_shape.h.

References m_end.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_TEXTBOX::GetBotRight(), GetRectangleHeight(), PCB_TEXTBOX::GetTopLeft(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

◆ GetFillColor()

COLOR4D EDA_SHAPE::GetFillColor ( ) const

inlineinherited

◆ GetFillMode()

FILL_T EDA_SHAPE::GetFillMode ( ) const

inlineinherited

Definition at line 150 of file eda_shape.h.

References m_fill.

◆ GetFillModeProp()

UI_FILL_MODE EDA_SHAPE::GetFillModeProp ( ) const

inherited

Definition at line 728 of file eda_shape.cpp.

References CROSS_HATCH, HATCH, m_fill, NO_FILL, NONE, REVERSE_HATCH, and SOLID.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 167 of file eda_item.h.

References m_flags.

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

◆ GetFlippedLayer()

PCB_LAYER_ID BOARD_ITEM::GetFlippedLayer ( PCB_LAYER_ID aLayer ) const

inherited

Return the layer paired with aLayer on the opposite side of the board.

Uses the parent board's layer mapping when available. Library items and other detached items use the standard front/back layer pairs.

Definition at line 197 of file board_item.cpp.

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

Referenced by FOOTPRINT::Flip(), PAD::Flip(), PCB_ARC::Flip(), PCB_BARCODE::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_DRILL_MAP::Flip(), PCB_GENERATOR::Flip(), PCB_POINT::Flip(), PCB_REFERENCE_IMAGE::Flip(), PCB_SHAPE::Flip(), PCB_TABLE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), PCB_VIA::Flip(), PCB_VIA_STACK::Flip(), and ZONE::Flip().

◆ GetFocusPosition()

const VECTOR2I PCB_SHAPE::GetFocusPosition ( ) const

overridevirtual

Allows items to return their visual center rather than their anchor.

For some shapes this is similar to GetCenter(), but for unfilled shapes a point on the outline is better.

Reimplemented from EDA_ITEM.

Definition at line 741 of file pcb_shape.cpp.

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

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 167 of file view_item.h.

References m_forcedTransparency.

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

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 461 of file board_item.cpp.

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

Referenced by PCB_IO_IPC2581::addLocationNode(), PCB_IO_IPC2581::addPackage(), EDA_DATA::PACKAGE::AddPin(), CHECK_SHAPE_LIBPOS_MIRROR(), PCB_IO_KICAD_SEXPR::format(), PCB_WRITER_V10::format(), PCB_WRITER_V9::format(), PCB_FIELDS_GRID_TABLE::GetValue(), FOOTPRINT::cmp_drawings::operator()(), 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 65 of file pcb_shape.h.

References FRAME_PCB_EDITOR, and EDA_SHAPE::getFriendlyName().

Referenced by GetItemDescription().

◆ getFriendlyName()

wxString EDA_SHAPE::getFriendlyName ( FRAME_T aFrameType ) const

protectedinherited

Definition at line 1514 of file eda_shape.cpp.

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

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

◆ GetHatching()

const SHAPE_POLY_SET & EDA_SHAPE::GetHatching ( ) const

inherited

Definition at line 741 of file eda_shape.cpp.

References m_hatchingCache, and UpdateHatching().

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

◆ getHatchingKnockouts()

SHAPE_POLY_SET PCB_SHAPE::getHatchingKnockouts ( ) const

overrideprotectedvirtual

Reimplemented from EDA_SHAPE.

Definition at line 640 of file pcb_shape.cpp.

References SHAPE_POLY_SET::Append(), ARC_LOW_DEF, B_CrtYd, BOARD_ITEM::BOARD_ITEM(), ERROR_OUTSIDE, F_CrtYd, BOARD_ITEM::GetBoard(), EDA_ITEM::GetBoundingBox(), GetBoundingBox(), EDA_SHAPE::GetHatchLineSpacing(), BOARD_ITEM::GetLayer(), GetLayer(), BOARD_ITEM::GetParentFootprint(), BOX2< Vec >::Intersects(), EDA_TEXT::IsVisible(), PCB_FIELD_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TEXTBOX_T, RECURSE, and EDA_ITEM::Type().

◆ GetHatchLines()

const std::vector< SEG > & EDA_SHAPE::GetHatchLines ( ) const

inherited

Definition at line 752 of file eda_shape.cpp.

References m_hatchingCache, and UpdateHatching().

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

◆ GetHatchLineSpacing()

virtual int EDA_SHAPE::GetHatchLineSpacing ( ) const

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 168 of file eda_shape.h.

References GetHatchLineWidth().

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

◆ GetHatchLineWidth()

virtual int EDA_SHAPE::GetHatchLineWidth ( ) const

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 167 of file eda_shape.h.

References GetEffectiveWidth().

Referenced by KIGFX::PCB_PAINTER::draw(), 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

aUnitsProvider	is the UNITS_PROVIDER object to handle item units.
aFull	is a flag to get the extend (full) description.

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Reimplemented in PCB_TABLECELL, and PCB_TEXTBOX.

Definition at line 1735 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_CONNECTED_ITEM.

Definition at line 70 of file pcb_shape.h.

References BOARD_ITEM::m_layer.

◆ GetLayerName() [1/2]

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

References GetLayerName(), and m_layer.

◆ GetLayerName() [2/2]

wxString BOARD_ITEM::GetLayerName ( PCB_LAYER_ID aLayer ) const

inherited

Return the name of a PCB layer using the owning board's layer names when available.

Definition at line 246 of file board_item.cpp.

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

◆ 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 503 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(), PCB_WRITER_V10::format(), PCB_WRITER_V9::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 542 of file eda_shape.cpp.

References ARC, EDA_ANGLE::AsRadians(), BEZIER, buildShapeEllipse(), SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CSegment(), VECTOR2< T >::Distance(), ELLIPSE, ELLIPSE_ARC, GetArcAngle(), GetEnd(), SHAPE_ELLIPSE::GetLength(), GetPolyShape(), GetRadius(), GetStart(), SEG::Length(), m_bezierPoints, m_shape, POLY, SEGMENT, SHAPE_LINE_CHAIN::SegmentCount(), SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

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

◆ GetLibPoly()

const SHAPE_POLY_SET & PCB_SHAPE::GetLibPoly ( ) const

inline

Definition at line 290 of file pcb_shape.h.

References m_libPoly.

Referenced by PCB_IO_KICAD_SEXPR::format().

◆ GetLibraryArcMid()

VECTOR2I PCB_SHAPE::GetLibraryArcMid ( ) const

Definition at line 1348 of file pcb_shape.cpp.

References ARC, EDA_SHAPE::GetArcMid(), m_libArcMid, m_libShape, and transformFp().

Referenced by BOOST_AUTO_TEST_CASE(), PCB_IO_KICAD_SEXPR::format(), FOOTPRINT::cmp_drawings::operator()(), and shapeNeedsUpdate().

◆ GetLibraryBezierC1()

VECTOR2I PCB_SHAPE::GetLibraryBezierC1 ( ) const

Definition at line 1360 of file pcb_shape.cpp.

References EDA_SHAPE::GetBezierC1(), BOARD_ITEM::GetParent(), m_libBezierC1, PCB_PAD_T, transformFp(), and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT::cmp_drawings::operator()(), and shapeNeedsUpdate().

◆ GetLibraryBezierC2()

VECTOR2I PCB_SHAPE::GetLibraryBezierC2 ( ) const

Definition at line 1372 of file pcb_shape.cpp.

References EDA_SHAPE::GetBezierC2(), BOARD_ITEM::GetParent(), m_libBezierC2, PCB_PAD_T, transformFp(), and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT::cmp_drawings::operator()(), and shapeNeedsUpdate().

◆ GetLibraryCornerRadius()

int PCB_SHAPE::GetLibraryCornerRadius ( ) const

inline

Definition at line 235 of file pcb_shape.h.

References m_libCornerRadius.

Referenced by PCB_IO_KICAD_SEXPR::format().

◆ GetLibraryEllipseCenter()

VECTOR2I PCB_SHAPE::GetLibraryEllipseCenter ( ) const

inline

Definition at line 237 of file pcb_shape.h.

References m_libEllipseCenter.

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

◆ GetLibraryEllipseEndAngle()

EDA_ANGLE PCB_SHAPE::GetLibraryEllipseEndAngle ( ) const

inline

Definition at line 242 of file pcb_shape.h.

References m_libEllipseEndAngle.

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

◆ GetLibraryEllipseMajorRadius()

int PCB_SHAPE::GetLibraryEllipseMajorRadius ( ) const

inline

Definition at line 238 of file pcb_shape.h.

References m_libEllipseMajorRadius.

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

◆ GetLibraryEllipseMinorRadius()

int PCB_SHAPE::GetLibraryEllipseMinorRadius ( ) const

inline

Definition at line 239 of file pcb_shape.h.

References m_libEllipseMinorRadius.

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

◆ GetLibraryEllipseRotation()

EDA_ANGLE PCB_SHAPE::GetLibraryEllipseRotation ( ) const

inline

Definition at line 240 of file pcb_shape.h.

References m_libEllipseRotation.

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

◆ GetLibraryEllipseStartAngle()

EDA_ANGLE PCB_SHAPE::GetLibraryEllipseStartAngle ( ) const

inline

Definition at line 241 of file pcb_shape.h.

References m_libEllipseStartAngle.

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

◆ GetLibraryEnd()

VECTOR2I PCB_SHAPE::GetLibraryEnd ( ) const

inline

◆ GetLibraryPolyShape()

SHAPE_POLY_SET PCB_SHAPE::GetLibraryPolyShape ( ) const

Definition at line 1384 of file pcb_shape.cpp.

References BOARD_ITEM::GetParent(), EDA_SHAPE::GetPolyShape(), m_libPoly, PCB_PAD_T, transformFp(), transformPolyVertices(), and EDA_ITEM::Type().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FOOTPRINT::cmp_drawings::operator()(), and shapeNeedsUpdate().

◆ GetLibraryShape()

SHAPE_T PCB_SHAPE::GetLibraryShape ( ) const

inline

Definition at line 234 of file pcb_shape.h.

References m_libShape.

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

◆ GetLibraryStart()

VECTOR2I PCB_SHAPE::GetLibraryStart ( ) const

inline

◆ GetLineColor()

COLOR4D EDA_SHAPE::GetLineColor ( ) const

inlineinherited

Definition at line 174 of file eda_shape.h.

References m_stroke.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ GetLineEndingEndpoints()

bool EDA_SHAPE::GetLineEndingEndpoints	(	VECTOR2I &	aStartPoint,
		VECTOR2I &	aEndPoint ) const

inherited

Return the source endpoints used to place line endings.

Returns: false if the shape does not have usable endpoints for line endings.

Definition at line 4224 of file eda_shape.cpp.

References ARC, BEZIER, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), ELLIPSE_ARC, GetBezierPoints(), GetEnd(), GetPolyShape(), GetStart(), m_shape, SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::PointCount(), POLY, and SEGMENT.

Referenced by BOARD_ADAPTER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EXPORTER_STEP::buildGraphic3DShape(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), GetLineEndingsBoundingBox(), lowerLineEndingShape(), MakeLineEndingEffectiveShapes(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), TransformLineEndingsToPolygon(), and unsafeLineEndings().

◆ GetLineEndingsBoundingBox()

bool EDA_SHAPE::GetLineEndingsBoundingBox	(	BOX2I &	aBBox,
		int	aLineWidth ) const

inherited

Definition at line 2984 of file eda_shape.cpp.

References ARROW_OPEN, GetEndingTangents(), GetLineEndingEndpoints(), LINE_ENDING::GetShapes(), LINE_ENDING::GetStrokeWidth(), LINE_ENDING::GetStyle(), hasLineEnding(), BOX2< Vec >::Inflate(), m_endEnding, m_startEnding, BOX2< Vec >::Merge(), NONE, and BOX2< Vec >::Normalize().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_SHAPE::GetBoundingBox(), and SCH_LINE::GetBoundingBox().

◆ GetLineStyle()

LINE_STYLE EDA_SHAPE::GetLineStyle ( ) const

inherited

Definition at line 3850 of file eda_shape.cpp.

References DEFAULT, m_stroke, and SOLID.

Referenced by BOOST_AUTO_TEST_CASE(), EXPORTER_STEP::buildGraphic3DShape(), canLowerLineEndings(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), hash_fp_item(), PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC(), SCH_TEXTBOX::Serialize(), and unsafeLineEndings().

◆ 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 179 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 190 of file board_connected_item.h.

◆ GetLocalRatsnestVisible()

bool BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible ( ) const

inlineinherited

Definition at line 209 of file board_connected_item.h.

References m_localRatsnestVisible.

Referenced by BOARD::ExchangeFootprint().

◆ GetLocalSolderMaskMargin()

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

inline

Definition at line 350 of file pcb_shape.h.

References m_solderMaskMargin.

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

◆ GetMaxError()

int BOARD_ITEM::GetMaxError ( ) const

inherited

Definition at line 179 of file board_item.cpp.

References ARC_HIGH_DEF, and GetBoard().

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

◆ getMaxError()

int PCB_SHAPE::getMaxError ( ) const

overrideprotectedvirtual

Reimplemented from EDA_SHAPE.

Definition at line 1831 of file pcb_shape.cpp.

References BOARD_ITEM::GetMaxError().

Referenced by rebakeFromTransform().

◆ 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 1780 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 1710 of file pcb_shape.cpp.

References _, BOARD_ITEM::GetLayerName(), BOARD_CONNECTED_ITEM::GetNetCode(), BOARD_CONNECTED_ITEM::GetNetname(), BOARD_ITEM::GetParentFootprint(), BOARD_ITEM::IsLocked(), BOARD_ITEM::IsOnCopperLayer(), PCB_EDIT_FRAME_NAME, and EDA_SHAPE::ShapeGetMsgPanelInfo().

◆ GetNet()

NETINFO_ITEM * BOARD_CONNECTED_ITEM::GetNet ( ) const

inlineinherited

Return NETINFO_ITEM object for a given item.

Definition at line 81 of file board_connected_item.h.

References m_netinfo.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), TEARDROP_MANAGER::buildCrossingStub(), PNS_KICAD_IFACE::createBoardItem(), CONVERT_TOOL::CreateLines(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_TUNING_PATTERN::EditStart(), EDIT_TOOL::FilletTracks(), PNS::NODE::FindItemByParent(), PAD::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), MODEL_ZONES_OVERVIEW::GetValueByRow(), PCB_TUNING_PATTERN::initBaseLines(), isCoupledDiffPairFunc(), PCB_IO_SPRINT_LAYOUT::loadBoard(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), ROUTER_TOOL::OptimizeSelected(), PartitionNetChainAroundNet(), BOARD_EDITOR_CONTROL::RepairBoard(), BOARD_INSPECTION_TOOL::reportClearance(), test::DRC_TEST_PROVIDER_DIFF_PAIR_COUPLING::Run(), PCB_EDIT_FRAME::saveSelectionToDesignBlock(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::selectNetChain(), 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(), PCB_CONTROL::UpdateMessagePanel(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ 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 149 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 122 of file board_connected_item.cpp.

References m_netinfo.

◆ GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inherited

Returns: the full netname.

Definition at line 155 of file board_connected_item.cpp.

References m_netinfo.

Referenced by STEP_PCB_MODEL::AddPadShape(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), EXPORTER_STEP::buildGraphic3DShape(), EXPORTER_STEP::buildTrack3DShape(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PAD::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_NETLIST_UPDATER::getNetname(), GetNetnameMsg(), ZONE_SEARCH_HANDLER::getResultCell(), ALTIUM_PCB::HelperCreateTuningPatterns(), isCoupledDiffPairFunc(), FABMASTER::loadZone(), PackNet(), BRDITEMS_PLOTTER::PlotPad(), BRDITEMS_PLOTTER::PlotShape(), BRDITEMS_PLOTTER::PlotZone(), BOARD_INSPECTION_TOOL::reportClearance(), 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 161 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 110 of file board_connected_item.cpp.

References BOARD_ITEM::GetBoard(), DRC_ENGINE::GetCachedOwnClearance(), BOARD::GetDesignSettings(), and BOARD_DESIGN_SETTINGS::m_DRCEngine.

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

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( ) const

inlineinherited

Definition at line 267 of file board_item.h.

References EDA_ITEM::m_parent.

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

◆ GetParentAsString()

wxString BOARD_ITEM::GetParentAsString ( ) const

inherited

For "parent" property.

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

Definition at line 497 of file board_item.cpp.

References EDA_ITEM::m_parent.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ GetParentFootprint()

FOOTPRINT * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 115 of file board_item.cpp.

References EDA_ITEM::findParent(), and PCB_FOOTPRINT_T.

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

◆ GetParentGroup()

virtual EDA_GROUP * EDA_ITEM::GetParentGroup ( ) const

inlinevirtualinherited

Reimplemented in PCB_TABLECELL, and SCH_TABLECELL.

Definition at line 116 of file eda_item.h.

References m_group.

◆ GetParentGroupId()

KIID EDA_ITEM::GetParentGroupId ( ) const

inherited

Definition at line 232 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

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

◆ GetPointCount()

int EDA_SHAPE::GetPointCount ( ) const

inherited

Returns: the number of corners of the polygonal shape.

Definition at line 3093 of file eda_shape.cpp.

References GetPolyShape(), SHAPE_POLY_SET::OutlineCount(), and SHAPE_POLY_SET::VertexCount().

Referenced by calcEdit(), SCH_SHAPE::GetItemDescription(), GRAPHICS_CLEANER::isNullShape(), and SCH_IO_KICAD_SEXPR_PARSER::ParseSchematic().

◆ GetPolyPoints()

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

inherited

Duplicate the polygon outlines into a flat list of VECTOR2I points.

Outlines (and holes) are appended in order; primarily intended for legacy callers that expect explicit point buffers rather than SHAPE objects.

Definition at line 3048 of file eda_shape.cpp.

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

Referenced by AssertOutlineValid(), BOOST_AUTO_TEST_CASE(), SCH_SHAPE::IsEndPoint(), SCH_SCREEN::MarkConnections(), SegmentIntersectsBoard(), and CREEPAGE_GRAPH::TransformEdgeToCreepShapes().

◆ GetPolyShape() [1/2]

SHAPE_POLY_SET & EDA_SHAPE::GetPolyShape ( )

inherited

Definition at line 3069 of file eda_shape.cpp.

References m_poly.

◆ GetPolyShape() [2/2]

const SHAPE_POLY_SET & EDA_SHAPE::GetPolyShape ( ) const

inherited

Definition at line 3077 of file eda_shape.cpp.

References m_poly.

◆ GetPosition()

VECTOR2I PCB_SHAPE::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 78 of file pcb_shape.h.

References EDA_SHAPE::getPosition().

Referenced by PCB_IO_IPC2581::addLocationNode(), BOARD_ADAPTER::addShape(), KI_TEST::CheckFpShape(), 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 531 of file eda_shape.cpp.

References ARC, SHAPE_POLY_SET::CVertex(), ELLIPSE, ELLIPSE_ARC, getCenter(), GetPolyShape(), 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 1380 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 EE_GRID_HELPER::AddConstructionItems(), PCB_GRID_HELPER::AddConstructionItems(), FEATURES_MANAGER::AddShape(), CREEPAGE_GRAPH::Addshape(), BOARD_ADAPTER::addShape(), PCB_IO_IPC2581::addShape(), BOARD_CONSTRAINT_ADAPTER::ApplyReferenceValues(), BoardItemIntersectable(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), buildCarrier(), calcEdit(), CheckLibSymbolGraphics(), computeArcBBox(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), editArcEndpointKeepCenterAndRadius(), FabMaskShape(), formatCircle(), formatCircle(), formatCircle(), getBoundingBox(), PCB_SHAPE::GetConnectionPoints(), PCB_SHAPE::GetFocusPosition(), SCH_SHAPE::GetItemDescription(), GetLength(), hash_fp_item(), hashShape(), hitTest(), hitTest(), idf_append_shape(), GRAPHICS_CLEANER::isNullShape(), makeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromClosedGraphics(), makeShortenedBodyShapes(), outlineProximity(), ALTIUM_PCB::Parse(), ORCAD_CONVERTER::placeInstance(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), processClosedShape(), OUTSET_ROUTINE::ProcessItem(), POLYGON_BOOLEAN_ROUTINE::ProcessShape(), CONSTRAINT_OVERLAY::render(), 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(), TransformWithLineEndingsToPolygon(), CREEPAGE_OVERLAY::Update(), ARC_GEOM_SYNCER::updateCRAA(), 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

◆ GetRolloverPos()

VECTOR2I EDA_ITEM::GetRolloverPos ( ) const

inlineinherited

Definition at line 143 of file eda_item.h.

References m_rolloverPos.

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

◆ GetSegmentAngle()

EDA_ANGLE EDA_SHAPE::GetSegmentAngle ( ) const

inherited

Definition at line 1462 of file eda_shape.cpp.

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

◆ GetShape()

SHAPE_T EDA_SHAPE::GetShape ( ) const

inlineinherited

Definition at line 177 of file eda_shape.h.

References m_shape.

◆ GetShortenedBodyPolyPoints()

bool EDA_SHAPE::GetShortenedBodyPolyPoints	(	const SHAPE_LINE_CHAIN &	aOutline,
		int	aOutlineIdx,
		std::vector< VECTOR2I > &	aPoints,
		int	aLineWidth ) const

inherited

Copy an outline and apply line-ending body shortening when applicable.

Returns: false if the outline is invalid or the line endings consume its body.

Definition at line 4542 of file eda_shape.cpp.

References SHAPE_LINE_CHAIN::CPoints(), SHAPE_LINE_CHAIN::PointCount(), and ShortenBodyPolyPoints().

Referenced by BOARD_ADAPTER::addShape(), BOOST_AUTO_TEST_CASE(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), makeShortenedBodyShapes(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), and TransformWithLineEndingsToPolygon().

◆ GetShortNetname()

const wxString & BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

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

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

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

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

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 364 of file eda_item.h.

References GetPosition().

◆ GetStart()

const VECTOR2I & EDA_SHAPE::GetStart ( ) const

inlineinherited

Return the starting point of the graphic.

Definition at line 283 of file eda_shape.h.

References m_start.

◆ GetStartEnding()

const LINE_ENDING & EDA_SHAPE::GetStartEnding ( ) const

inlineinherited

◆ GetStartEndingLength()

int EDA_SHAPE::GetStartEndingLength ( ) const

inlineinherited

Definition at line 197 of file eda_shape.h.

References m_startEnding.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ GetStartEndingStrokeWidth()

int EDA_SHAPE::GetStartEndingStrokeWidth ( ) const

inlineinherited

Definition at line 207 of file eda_shape.h.

References m_startEnding.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ GetStartEndingStyle()

LINE_ENDING_STYLE EDA_SHAPE::GetStartEndingStyle ( ) const

inlineinherited

Definition at line 191 of file eda_shape.h.

References m_startEnding.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), and hasLineEndings().

◆ GetStartEndingWidth()

int EDA_SHAPE::GetStartEndingWidth ( ) const

inlineinherited

Definition at line 199 of file eda_shape.h.

References m_startEnding.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ GetStartX()

int EDA_SHAPE::GetStartX ( ) const

inlineinherited

Definition at line 285 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 284 of file eda_shape.h.

References m_start.

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

◆ GetStroke()

STROKE_PARAMS PCB_SHAPE::GetStroke ( ) const

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 1065 of file pcb_shape.cpp.

References GetWidth(), EDA_SHAPE::m_stroke, and STROKE_PARAMS::SetWidth().

Referenced by BOARD_ADAPTER::addShape(), PCB_IO_IPC2581::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), FOOTPRINT::BuildCourtyardCaches(), KI_TEST::CheckFpShape(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), drawPcbShapeWithStyle(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), PCB_TEXTBOX::GetEffectiveShape(), PCB_TEXTBOX::GetLegacyTextMargin(), PCB_TEXTBOX::GetPolygonalBoxShape(), BRDITEMS_PLOTTER::PlotShape(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), CONVERT_TOOL::SegmentToArc(), shapeNeedsUpdate(), and PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog().

◆ GetTeardropAllowSpanTwoTracks()

bool BOARD_CONNECTED_ITEM::GetTeardropAllowSpanTwoTracks ( ) const

inlineinherited

Definition at line 236 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropBestLengthRatio()

double BOARD_CONNECTED_ITEM::GetTeardropBestLengthRatio ( ) const

inlineinherited

Definition at line 218 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropBestWidthRatio()

double BOARD_CONNECTED_ITEM::GetTeardropBestWidthRatio ( ) const

inlineinherited

Definition at line 224 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropCurved()

bool BOARD_CONNECTED_ITEM::GetTeardropCurved ( ) const

inlineinherited

Definition at line 230 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropMaxLength()

int BOARD_CONNECTED_ITEM::GetTeardropMaxLength ( ) const

inlineinherited

Definition at line 221 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropMaxTrackWidth()

double BOARD_CONNECTED_ITEM::GetTeardropMaxTrackWidth ( ) const

inlineinherited

Definition at line 239 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropMaxWidth()

int BOARD_CONNECTED_ITEM::GetTeardropMaxWidth ( ) const

inlineinherited

Definition at line 227 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ GetTeardropParams() [1/2]

TEARDROP_PARAMETERS & BOARD_CONNECTED_ITEM::GetTeardropParams ( )

inlineinherited

Definition at line 211 of file board_connected_item.h.

References m_teardropParams.

Referenced by PAD::Deserialize(), PCB_VIA::Deserialize(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), PCB_IO_KICAD_SEXPR::format(), PCB_WRITER_V10::format(), PCB_WRITER_V9::format(), ZONE::operator==(), DIALOG_GLOBAL_EDIT_TEARDROPS::processItem(), PAD::Serialize(), PCB_VIA::Serialize(), ZONE::Similarity(), DIALOG_PAD_PROPERTIES::transferDataToPad(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataToWindow(), and DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem().

◆ GetTeardropParams() [2/2]

const TEARDROP_PARAMETERS & BOARD_CONNECTED_ITEM::GetTeardropParams ( ) const

inlineinherited

Definition at line 212 of file board_connected_item.h.

References m_teardropParams.

◆ GetTeardropPreferZoneConnections()

bool BOARD_CONNECTED_ITEM::GetTeardropPreferZoneConnections ( ) const

inlineinherited

Definition at line 233 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 215 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 183 of file eda_item.h.

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

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

◆ GetTopLeft()

virtual VECTOR2I EDA_SHAPE::GetTopLeft ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 364 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 556 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

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 725 of file pcb_shape.cpp.

References fpScaleLinear(), EDA_SHAPE::GetWidth(), KiROUND(), and transformFp().

Referenced by FEATURES_MANAGER::AddShape(), BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EXPORTER_STEP::buildGraphic3DShape(), CONVERT_TOOL::CreateLines(), doConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), drawPcbShapeWithStyle(), ellipseToPolygon(), FabMaskShape(), GetBoardItemWidth(), PCB_TEXTBOX::GetBoundingBox(), GetCoverageArea(), PCB_TEXTBOX::GetEffectiveShape(), PCB_TEXTBOX::GetLegacyTextMargin(), GetSolderMaskExpansion(), GetStroke(), hash_fp_item(), FABMASTER::loadPolygon(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromChainedSegs(), EDIT_TOOL::ModifyLines(), ALLEGRO::BOARD_BUILDER::GRAPHIC_KEY_HASH::operator()(), FOOTPRINT::cmp_drawings::operator()(), KICAD_FORMAT::LEGACY::orderFpShapes(), BRDITEMS_PLOTTER::PlotShape(), DOGBONE_CORNER_ROUTINE::ProcessLinePair(), LINE_CHAMFER_ROUTINE::ProcessLinePair(), LINE_FILLET_ROUTINE::ProcessLinePair(), POLYGON_BOOLEAN_ROUTINE::ProcessShape(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), CONVERT_TOOL::SegmentToArc(), AR_MATRIX::TracePcbShape(), PCB_TEXTBOX::TransformShapeToPolygon(), and ViewBBox().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 134 of file board_item.h.

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

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 140 of file board_item.h.

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

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

◆ HasCustomProperties()

bool EDA_ITEM::HasCustomProperties ( ) const

inlineinherited

Definition at line 269 of file eda_item.h.

References m_customProperties.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), countCustomProperties(), and KICAD_FORMAT::FormatCustomProperties().

◆ HasDrilledHole()

virtual bool BOARD_ITEM::HasDrilledHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 213 of file board_item.h.

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

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 168 of file eda_item.h.

References m_flags.

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

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 208 of file board_item.h.

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

◆ HasLineStroke()

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

◆ HasSelectedAncestorGroup()

bool EDA_ITEM::HasSelectedAncestorGroup ( ) const

inherited

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

Definition at line 241 of file eda_item.cpp.

References EDA_ITEM(), and group.

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

◆ HasSolderMask()

bool PCB_SHAPE::HasSolderMask ( ) const

inline

Definition at line 347 of file pcb_shape.h.

References m_hasSolderMask.

Referenced by BOARD_ADAPTER::addShape(), BOARD_ADAPTER::createLayers(), KIGFX::PCB_PAINTER::draw(), FabMaskShape(), PCB_IO_KICAD_SEXPR::format(), PCB_WRITER_V10::format(), PCB_WRITER_V9::format(), GetEffectiveShape(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), BRDITEMS_PLOTTER::PlotShape(), Serialize(), and transformFPShapesToPolySet().

◆ hatching()

SHAPE_POLY_SET & EDA_SHAPE::hatching ( ) const

protectedinherited

Definition at line 763 of file eda_shape.cpp.

References m_hatchingCache.

Referenced by UpdateHatching().

◆ hatchLines()

std::vector< SEG > & EDA_SHAPE::hatchLines ( ) const

protectedinherited

Definition at line 772 of file eda_shape.cpp.

References m_hatchingCache.

Referenced by UpdateHatching().

◆ 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 167 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 172 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 162 of file pcb_shape.h.

References EDA_SHAPE::hitTest().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FindSnapGraphic(), PCB_TEXTBOX::HitTest(), and NearestConstrainedShape().

◆ hitTest() [1/3]

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

protectedinherited

Definition at line 1884 of file eda_shape.cpp.

References ARC, BEZIER, KIGEOM::BoxToLineChain(), buildShapeEllipse(), chain, CIRCLE, BOX2< Vec >::Contains(), SHAPE_ELLIPSE::ConvertToPolyline(), ELLIPSE, ELLIPSE_ARC, getBoundingBox(), getCenter(), GetEffectiveWidth(), GetEnd(), getMaxError(), BEZIER_POLY::GetPoly(), GetPolyShape(), GetRadius(), GetRectangleHeight(), GetRectangleWidth(), GetRectCorners(), GetStart(), GetWidth(), hasLineEnding(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), BOX2< Vec >::IntersectsCircleEdge(), IsAnyFill(), m_bezierC1, m_bezierC2, m_bezierPoints, m_cornerRadius, m_end, m_endEnding, m_shape, m_start, m_startEnding, MakeEffectiveShapesWithLineEndings(), BOX2< Vec >::Normalize(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), POLY, RECTANGLE, SEGMENT, SHAPE_T_asString(), KIGEOM::ShapeHitTest(), ROUNDRECT::TransformToPolygon(), and UNIMPLEMENTED_FOR.

◆ hitTest() [2/3]

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

protectedinherited

Definition at line 2108 of file eda_shape.cpp.

References GetEffectiveWidth(), hasLineEnding(), m_endEnding, m_startEnding, MakeEffectiveShapes(), MakeEffectiveShapesWithLineEndings(), and KIGEOM::ShapeHitTest().

◆ hitTest() [3/3]

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

protectedinherited

Definition at line 1686 of file eda_shape.cpp.

References SHAPE_POLY_SET::Append(), ARC, BEZIER, buildShapeEllipse(), CalcArcAngles(), CIRCLE, Collide(), SHAPE::Collide(), SHAPE_POLY_SET::Collide(), SHAPE_POLY_SET::CollideEdge(), copy, VECTOR2< T >::Distance(), ELLIPSE, ELLIPSE_ARC, VECTOR2< T >::EuclideanNorm(), getCenter(), GetEffectiveWidth(), GetEnd(), GetHatching(), getMaxError(), BEZIER_POLY::GetPoly(), GetPolyShape(), GetRadius(), GetRectangleHeight(), GetRectangleWidth(), GetRectCorners(), GetStart(), GetWidth(), hasLineEnding(), IsClosed(), IsFilledForHitTesting(), IsHatchedFill(), IsProxyItem(), m_bezierC1, m_bezierC2, m_bezierPoints, m_cornerRadius, m_end, m_endEnding, m_shape, m_start, m_startEnding, MakeEffectiveShapesWithLineEndings(), SHAPE_POLY_SET::NewOutline(), EDA_ANGLE::Normalize(), POLY, radius, RECTANGLE, SEGMENT, SHAPE_T_asString(), SHAPE_ELLIPSE::SquaredDistance(), 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 120 of file eda_shape.h.

References GetFillMode(), and NO_FILL.

Referenced by computeArcBBox(), PCB_WRITER_V9::format(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), PCB_SHAPE::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 98 of file view_item.h.

References m_isBOARD_ITEM.

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

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

References BRIGHTENED, m_flags, and m_netHighlighted.

◆ IsClockwiseArc()

bool EDA_SHAPE::IsClockwiseArc ( ) const

inherited

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

◆ 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 437 of file pcb_shape.cpp.

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

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 135 of file eda_item.h.

References ENTERED, and m_flags.

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

◆ IsFilledForHitTesting()

virtual bool EDA_SHAPE::IsFilledForHitTesting ( ) const

inlinevirtualinherited

Reimplemented in PCB_TABLECELL, SCH_RULE_AREA, and SCH_TABLECELL.

Definition at line 139 of file eda_shape.h.

References IsSolidFill().

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 233 of file eda_item.h.

References m_forceVisible.

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

◆ IsGroupableType()

bool BOARD_ITEM::IsGroupableType ( ) const

inherited

◆ IsHatchedFill()

bool EDA_SHAPE::IsHatchedFill ( ) const

inlineinherited

◆ IsIndexedInBoard()

bool BOARD_ITEM::IsIndexedInBoard ( ) const

inlineinherited

Definition at line 429 of file board_item.h.

References m_owningIndex.

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Reimplemented in PCB_BARCODE.

Definition at line 423 of file board_item.h.

References m_isKnockout.

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

◆ IsLayerAgnostic()

virtual bool BOARD_ITEM::IsLayerAgnostic ( ) const

inlinevirtualinherited

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

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

Reimplemented in FOOTPRINT, PCB_3D_BODY, PCB_CONSTRAINT, and PCB_GROUP.

Definition at line 308 of file board_item.h.

Referenced by FitsEnabledLayers().

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

overridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in PAD.

Definition at line 144 of file board_item.cpp.

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

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 130 of file eda_item.h.

References IS_CHANGED, and m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

◆ isMoving()

bool PCB_SHAPE::isMoving ( ) const

inlineoverrideprotectedvirtual

Reimplemented from EDA_SHAPE.

Definition at line 361 of file pcb_shape.h.

References EDA_ITEM::IsMoving().

◆ IsNetHighlighted()

bool EDA_ITEM::IsNetHighlighted ( ) const

inherited

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

Definition at line 125 of file eda_item.cpp.

References m_netHighlighted.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References IS_NEW, and m_flags.

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

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

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

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

Definition at line 190 of file board_item.h.

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

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

◆ IsOnLayer()

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 485 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(), BOARD_ADAPTER::addShape(), BOOST_FIXTURE_TEST_CASE(), EXPORTER_STEP::buildGraphic3DShape(), GRAPHICS_CLEANER::fixBoardOutlines(), isEdge(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), and transformFPTextToPolySet().

◆ IsPolyShapeValid()

bool EDA_SHAPE::IsPolyShapeValid ( ) const

inherited

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

Definition at line 3086 of file eda_shape.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FabMaskShape(), PCB_IO_KICAD_SEXPR::format(), PCB_WRITER_V10::format(), PCB_WRITER_V9::format(), idf_append_shape(), BRDITEMS_PLOTTER::PlotShape(), TransformShapeToPolygon(), and TransformWithLineEndingsToPolygon().

◆ IsProxyItem()

bool PCB_SHAPE::IsProxyItem ( ) const

inlineoverridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 155 of file pcb_shape.h.

References EDA_SHAPE::m_proxyItem.

Referenced by BOOST_AUTO_TEST_CASE(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PAD_TOOL::explodePad(), PCB_SHAPE_DESC::PCB_SHAPE_DESC(), PAD::Recombine(), Serialize(), 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 522 of file eda_item.h.

Referenced by Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References m_isRollover.

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

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 97 of file view_item.h.

References m_isSCH_ITEM.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 134 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsSideSpecific()

bool BOARD_ITEM::IsSideSpecific ( ) const

inherited

Definition at line 258 of file board_item.cpp.

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

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

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

Referenced by BOARD_INSPECTION_TOOL::reportClearance(), 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 401 of file pcb_shape.cpp.

References ARC, BEZIER, CIRCLE, Edge_Cuts, ELLIPSE, ELLIPSE_ARC, 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_ELLIPSE_ARC_T, PCB_SHAPE_LOCATE_ELLIPSE_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 401 of file eda_item.h.

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

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

◆ IterateForward() [2/2]

template<class T>

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

inlinestaticinherited

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

Definition at line 421 of file eda_item.h.

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

◆ LayerMaskDescribe()

wxString BOARD_ITEM::LayerMaskDescribe ( ) const

virtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 275 of file board_item.cpp.

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

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

◆ lodScaleForThreshold()

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

staticprotectedinherited

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

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

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

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

Definition at line 35 of file view_item.cpp.

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

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

◆ 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 565 of file eda_shape.h.

References makeEffectiveShapes().

Referenced by BOARD_ADAPTER::addShape(), BOOST_AUTO_TEST_CASE(), KIGFX::PCB_PAINTER::draw(), hitTest(), MakeEffectiveShapesForStroking(), and DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run().

◆ makeEffectiveShapes()

std::vector< SHAPE * > EDA_SHAPE::makeEffectiveShapes	(	bool	aEdgeOnly,
		bool	aLineChainOnly = false,
		bool	aHittesting = 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.
aHittesting

Definition at line 2386 of file eda_shape.cpp.

References ANGLE_360, ARC, SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), BEZIER, buildBezierToSegmentsPointsList(), buildShapeEllipse(), chain, CIRCLE, SHAPE_ELLIPSE::ConvertToPolyline(), SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CSegment(), ELLIPSE, ELLIPSE_ARC, GetArcAngle(), getCenter(), GetEffectiveWidth(), GetEnd(), getMaxError(), GetPolyShape(), GetRadius(), GetRectangleHeight(), GetRectangleWidth(), GetRectCorners(), GetStart(), SHAPE_LINE_CHAIN::IsArcSegment(), SHAPE_LINE_CHAIN::IsClosed(), IsFilledForHitTesting(), IsHatchedFill(), IsProxyItem(), IsSolidFill(), m_arcCenter, m_cornerRadius, m_end, m_shape, m_start, SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), POLY, RECTANGLE, SEGMENT, SHAPE_LINE_CHAIN::Segment(), SHAPE_LINE_CHAIN::SegmentCount(), SHAPE_T_asString(), ROUNDRECT::TransformToPolygon(), and UNIMPLEMENTED_FOR.

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

◆ MakeEffectiveShapesForHitTesting()

virtual std::vector< SHAPE * > EDA_SHAPE::MakeEffectiveShapesForHitTesting ( ) const

inlinevirtualinherited

Definition at line 585 of file eda_shape.h.

References makeEffectiveShapes().

Referenced by SCH_SELECTION_TOOL::GuessSelectionCandidates(), and PCB_SELECTION_TOOL::hitTestDistance().

◆ MakeEffectiveShapesForStroking()

std::vector< SHAPE * > EDA_SHAPE::MakeEffectiveShapesForStroking ( int aLineWidth = -1 ) const

inherited

Make a set of SHAPE objects to hand to STROKE_PARAMS::Stroke().

A Bezier comes back as one SHAPE_LINE_CHAIN and an ellipse as one SHAPE_ELLIPSE, so the pattern runs continuously along the curve instead of restarting at every point of its polyline approximation. Every other shape comes from MakeEffectiveShapes(), edges only.

If the shape has line endings that consume part of the body, the body is shortened accordingly (a shortened Bezier still comes back as one SHAPE_LINE_CHAIN).

Caller owns the objects.

Parameters

aLineWidth is the width used to size the line endings; -1 uses GetEffectiveWidth() (callers whose width is resolved externally, e.g. by render settings, must pass it explicitly).

Definition at line 2334 of file eda_shape.cpp.

References ARC, BEZIER, buildBezierToSegmentsPointsList(), buildShapeEllipse(), ELLIPSE, ELLIPSE_ARC, GetEffectiveWidth(), getMaxError(), m_endEnding, m_shape, m_startEnding, MakeEffectiveShapes(), makeShortenedBodyShapes(), POLY, SEGMENT, and ShortenedBezierPolyline().

Referenced by BOARD_ADAPTER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EXPORTER_STEP::buildGraphic3DShape(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), drawPcbShapeWithStyle(), and BRDITEMS_PLOTTER::PlotShape().

◆ MakeEffectiveShapesWithLineEndings()

std::vector< SHAPE * > EDA_SHAPE::MakeEffectiveShapesWithLineEndings ( int aLineWidth ) const

inherited

Make effective geometry for the shape body shortened for line endings plus the line-ending geometry itself.

Caller owns the objects.

Definition at line 2750 of file eda_shape.cpp.

References MakeLineEndingEffectiveShapes(), and makeShortenedBodyShapes().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_SHAPE::GetEffectiveShape(), SCH_LINE::HitTest(), SCH_LINE::HitTest(), SCH_LINE::HitTest(), hitTest(), hitTest(), hitTest(), and PNS_KICAD_IFACE_BASE::syncGraphicalItem().

◆ MakeLineEndingEffectiveShapes()

std::vector< SHAPE * > EDA_SHAPE::MakeLineEndingEffectiveShapes ( int aLineWidth ) const

inherited

Make the line-ending geometry associated with this shape.

Caller owns the objects.

Definition at line 2613 of file eda_shape.cpp.

References addLineEndingEffectiveShapes(), GetEndingTangents(), GetLineEndingEndpoints(), hasLineEnding(), m_endEnding, and m_startEnding.

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

◆ makeShortenedBodyShapes()

std::vector< SHAPE * > EDA_SHAPE::makeShortenedBodyShapes	(	int	aLineWidth,
		bool	aEdgeOnly = false ) const

protectedinherited

Make effective geometry for the shape body shortened for line endings, without the line-ending geometry itself.

Falls back to makeEffectiveShapes() when no shortening applies.

Caller owns the objects.

Definition at line 2637 of file eda_shape.cpp.

References ARC, BEZIER, buildShapeEllipse(), CalcArcAngles(), chain, SHAPE_ELLIPSE::ConvertToPolyline(), SHAPE_POLY_SET::COutline(), ELLIPSE_ARC, end, GetEffectiveWidth(), GetEnd(), getMaxError(), GetPolyShape(), GetRadius(), GetShortenedBodyPolyPoints(), GetStart(), SHAPE_LINE_CHAIN::IsClosed(), IsHatchedFill(), IsProxyItem(), IsSolidFill(), m_arcCenter, m_endEnding, m_shape, m_startEnding, makeEffectiveShapes(), SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::PointCount(), POLY, RotatePoint(), SEGMENT, ShortenArcForEndings(), ShortenedBezierPolyline(), and ShortenSegmentForEndings().

Referenced by MakeEffectiveShapesForStroking(), and MakeEffectiveShapesWithLineEndings().

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

Referenced by 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(), SCH_ITEM::MatchesNetName(), 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 318 of file eda_item.cpp.

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

◆ 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.
aFlipDirection	mirror across X axis instead of Y (the default).

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 1581 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 811 of file pcb_shape.cpp.

References move, and syncLibCoords().

Referenced by PCAD2KICAD::PCAD_ARC::AddToBoard(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), altiumMakePadLayerCustom(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperFoldPendingCopper(), PCB_TEXTBOX::Move(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), PCB_IO_EAGLE::packageWire(), PCB_IO_GEDA::parseElement(), GPCB_FPL_CACHE::parseFOOTPRINT(), and PAD::Recombine().

◆ move()

void EDA_SHAPE::move ( const VECTOR2I & aMoveVector )

protectedinherited

Definition at line 960 of file eda_shape.cpp.

References SEG::A, ARC, SEG::B, BEZIER, CIRCLE, ELLIPSE, ELLIPSE_ARC, GetPolyShape(), KI_FALLTHROUGH, m_arcCenter, m_arcMidData, m_bezierC1, m_bezierC2, m_bezierPoints, m_ellipse, m_end, m_hatchingCache, m_hatchingDirty, m_shape, m_start, SHAPE_POLY_SET::Move(), 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 824 of file pcb_shape.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE(), 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 883 of file pcb_shape.cpp.

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

◆ OnFootprintRescaled()

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

overridevirtual

Apply a parent footprint scale to this item.

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

Parameters

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

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 1038 of file pcb_shape.cpp.

References RebakeFromLib().

◆ OnFootprintTransformed()

void PCB_SHAPE::OnFootprintTransformed ( )

inlineoverridevirtual

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

Scaling uses OnFootprintRescaled.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 195 of file pcb_shape.h.

References RebakeFromLib().

Referenced by PCB_TEXTBOX::OnFootprintTransformed().

◆ operator<()

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

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

Definition at line 479 of file eda_item.cpp.

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

◆ operator==() [1/3]

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

inherited

◆ 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 1939 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 1950 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().

◆ OverrideLibBezier()

void PCB_SHAPE::OverrideLibBezier	(	const VECTOR2I &	aC1,
		const VECTOR2I &	aC2 )

inline

Definition at line 282 of file pcb_shape.h.

References m_libBezierC1, and m_libBezierC2.

Referenced by PAD::AddPrimitive(), and BOOST_AUTO_TEST_CASE().

◆ OverrideLibCoords()

void PCB_SHAPE::OverrideLibCoords	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		const VECTOR2I &	aArcMid = VECTOR2I( 0, 0 ) )

inline

Definition at line 271 of file pcb_shape.h.

References ARC, m_libArcMid, m_libEnd, m_libShape, and m_libStart.

Referenced by PAD::AddPrimitive(), PCB_IO_KICAD_SEXPR_PARSER::bakeTextBoxLib(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ OverrideLibCornerRadius()

void PCB_SHAPE::OverrideLibCornerRadius ( int aCornerRadius )

inline

Definition at line 280 of file pcb_shape.h.

References m_libCornerRadius.

◆ OverrideLibPoly()

void PCB_SHAPE::OverrideLibPoly ( const SHAPE_POLY_SET & aPoly )

inline

Definition at line 288 of file pcb_shape.h.

References m_libPoly.

Referenced by PAD::AddPrimitive(), PCB_IO_KICAD_SEXPR_PARSER::bakeTextBoxLib(), and BOOST_AUTO_TEST_CASE().

◆ PackNet()

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

inherited

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

◆ polygonArea()

double BOARD_ITEM::polygonArea ( SHAPE_POLY_SET & aPolySet )

staticprotectedinherited

Area of aPolySet with every contour closed first, holes subtracted.

Definition at line 412 of file board_item.cpp.

References SHAPE_POLY_SET::Area(), SHAPE_POLY_SET::Hole(), SHAPE_POLY_SET::HoleCount(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::SetClosed().

Referenced by FOOTPRINT::CoverageRatio(), GetCoverageArea(), FOOTPRINT::GetCoverageArea(), PAD::GetCoverageArea(), PCB_TEXT::GetCoverageArea(), PCB_TEXTBOX::GetCoverageArea(), and ZONE::GetCoverageArea().

◆ RebakeFromLib()

void PCB_SHAPE::RebakeFromLib ( )

Definition at line 1088 of file pcb_shape.cpp.

References FOOTPRINT::GetTransform(), rebakeFromTransform(), and transformFp().

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

◆ rebakeFromTransform()

void PCB_SHAPE::rebakeFromTransform ( const TRANSFORM_TRS & aXform )

protected

Definition at line 1099 of file pcb_shape.cpp.

References std::abs(), ANGLE_0, ANGLE_360, SHAPE_POLY_SET::Append(), TRANSFORM_TRS::Apply(), TRANSFORM_TRS::ApplyLinearScale(), ARC, BEZIER, CalcArcCenter(), chain, CIRCLE, SHAPE_LINE_CHAIN::CPoint(), DEGREES_T, ELLIPSE, ELLIPSE_ARC, ERROR_INSIDE, BOX2< Vec >::GetEnd(), getMaxError(), BOX2< Vec >::GetOrigin(), EDA_SHAPE::GetPolyShape(), TRANSFORM_TRS::GetRotate(), TRANSFORM_TRS::GetScaleX(), TRANSFORM_TRS::GetScaleY(), EDA_ANGLE::IsCardinal(), TRANSFORM_TRS::IsUniformScale(), KiROUND(), m_libArcMid, m_libBezierC1, m_libBezierC2, m_libCornerRadius, m_libEllipseCenter, m_libEllipseEndAngle, m_libEllipseMajorRadius, m_libEllipseMinorRadius, m_libEllipseRotation, m_libEllipseStartAngle, m_libEnd, m_libPoly, m_libShape, m_libStart, EDA_SHAPE::m_shape, BOX2< Vec >::Merge(), SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), POLY, EDA_SHAPE::RebuildBezierToSegmentsPointsList(), RECTANGLE, SHAPE_POLY_SET::RemoveAllContours(), EDA_SHAPE::SetArcGeometry(), EDA_SHAPE::SetBezierC1(), EDA_SHAPE::SetBezierC2(), SHAPE_LINE_CHAIN::SetClosed(), EDA_SHAPE::SetCornerRadius(), EDA_SHAPE::SetEllipseCenter(), SetEllipseCenter(), EDA_SHAPE::SetEllipseEndAngle(), SetEllipseEndAngle(), EDA_SHAPE::SetEllipseMajorRadius(), SetEllipseMajorRadius(), EDA_SHAPE::SetEllipseMinorRadius(), SetEllipseMinorRadius(), EDA_SHAPE::SetEllipseRotation(), SetEllipseRotation(), EDA_SHAPE::SetEllipseStartAngle(), SetEllipseStartAngle(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), transformPolyVertices(), and TransformRoundChamferedRectToPolygon().

Referenced by Flip(), RebakeFromLib(), and RebakeWithScale().

◆ RebakeWithScale()

void PCB_SHAPE::RebakeWithScale	(	double	aScaleX,
		double	aScaleY )

Definition at line 1080 of file pcb_shape.cpp.

References rebakeFromTransform(), and TRANSFORM_TRS::SetScale().

Referenced by PAD::rebakePrimitiveToFootprint().

◆ RebuildBezierToSegmentsPointsList() [1/2]

void EDA_SHAPE::RebuildBezierToSegmentsPointsList ( )

inlineinherited

Definition at line 555 of file eda_shape.h.

References getMaxError(), and RebuildBezierToSegmentsPointsList().

Referenced by beginEdit(), calcEdit(), Deserialize(), flip(), PCB_SHAPE::rebakeFromTransform(), RebuildBezierToSegmentsPointsList(), and scale().

◆ RebuildBezierToSegmentsPointsList() [2/2]

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

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

Definition at line 1212 of file eda_shape.cpp.

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

Referenced by KI_TEST::addBezier(), TARGET3001_PCB_BUILDER::addShape(), SCH_IO_GEDA::addSymbolGraphic(), BEZIER_DRAW_BEHAVIOR::ApplyToShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BuildCreepageBoardEdges(), idf_append_shape(), GRAPHICS_CLEANER::isNullShape(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), makeBezierChain(), SCH_IO_ALTIUM::ParseBezier(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_ALTIUM::ParseEllipticalArc(), SCH_SHAPE::Plot(), processShapeSegment(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), and GRAPHICS_IMPORTER::setupSplineOrLine().

◆ recalcEllipseArcEndpoints()

void EDA_SHAPE::recalcEllipseArcEndpoints ( )

protectedinherited

When m_shape == ELLIPSE_ARC, recompute m_start/m_end from m_ellipse.

No-op for other shapes.

Definition at line 1251 of file eda_shape.cpp.

References ELLIPSE, ELLIPSE_ARC, KiROUND(), m_arcCenter, m_editState, m_ellipse, m_end, m_shape, and m_start.

Referenced by endEdit(), flip(), rotate(), scale(), SetCenter(), SetEllipseCenter(), SetEllipseEndAngle(), SetEllipseMajorRadius(), SetEllipseMinorRadius(), SetEllipseRotation(), and SetEllipseStartAngle().

◆ RemapKIIDs()

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

inlinevirtualinherited

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

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

Reimplemented in PCB_CONSTRAINT.

Definition at line 288 of file board_item.h.

Referenced by PCB_CONTROL::placeBoardItems().

◆ RemoveConflictingCustomProperties()

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

inherited

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

Returns the keys removed, if any.

Definition at line 168 of file eda_item.cpp.

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

◆ RemoveCustomProperty()

void EDA_ITEM::RemoveCustomProperty ( const wxString & aKey )

inherited

Definition at line 161 of file eda_item.cpp.

References m_customProperties, and m_customPropsStorageCache.

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

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 196 of file eda_item.h.

◆ Replace() [1/2]

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

inlinevirtualinherited

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

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

Parameters

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

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

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

Definition at line 511 of file eda_item.h.

◆ Replace() [2/2]

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

staticinherited

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

Parameters

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

Returns: True if aText was modified, otherwise false.

Definition at line 396 of file eda_item.cpp.

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

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

◆ ResetUuid()

void BOARD_ITEM::ResetUuid ( )

inlineinherited

Definition at line 281 of file board_item.h.

References SetUuid().

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

◆ ResetUuidDirect()

void BOARD_ITEM::ResetUuidDirect ( )

inlineinherited

Definition at line 278 of file board_item.h.

References SetUuidDirect().

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

◆ Rotate()

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

overridevirtual

Rotate this object.

Parameters

aRotCentre	the rotation center point.
aAngle	the amount to rotation around the center point.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 903 of file pcb_shape.cpp.

References EDA_SHAPE::rotate(), and syncLibCoords().

Referenced by PCAD2KICAD::PCAD_ARC::AddToBoard(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), altiumMakePadLayerCustom(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ALTIUM_PCB::ConvertFills6ToBoardItem(), ALTIUM_PCB::ConvertFills6ToFootprintItem(), ALTIUM_PCB::ConvertFills6ToPcbShape(), PAD_TOOL::explodePad(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), ALTIUM_PCB::HelperFoldPendingCopper(), ALTIUM_PCB::HelperParsePad6NonCopper(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), PCB_IO_EAGLE::packageWire(), PCB_IO_GEDA::parseElement(), GPCB_FPL_CACHE::parseFOOTPRINT(), PAD::Recombine(), and PCB_TARGET::TransformShapeToPolygon().

◆ rotate()

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

protectedinherited

Definition at line 1088 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, ELLIPSE, ELLIPSE_ARC, getMaxError(), GetPolyShape(), GetRectangleHeight(), GetRectangleWidth(), GetStart(), EDA_ANGLE::IsCardinal(), m_arcCenter, m_arcMidData, m_bezierC1, m_bezierC2, m_bezierPoints, m_cornerRadius, m_ellipse, m_end, m_hatchingDirty, m_shape, m_start, POLY, recalcEllipseArcEndpoints(), RECTANGLE, SHAPE_POLY_SET::Rotate(), RotatePoint(), SEGMENT, SetShape(), SHAPE_T_asString(), ROUNDRECT::TransformToPolygon(), 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 265 of file board_item.h.

References BOARD_ITEM().

Referenced by BOARD_ITEM_INDEX::BindChildren(), BOARD_ITEM_INDEX::BindSubtree(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), CollectConstraintScopeIds(), BOARD_TEXT_VAR_ADAPTER::collectKeys(), PCB_GROUP::DeepDuplicate(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::Duplicate(), PCB_TABLE::Duplicate(), PCB_SELECTION_TOOL::HasLockedDescendant(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), BOARD_EDITOR_CONTROL::modifyLockSelected(), ARRAY_TOOL::onDialogClosed(), PCB_IO_KICAD_SEXPR_PARSER::Parse(), BOARD_COMMIT::propagateDamage(), BOARD_COMMIT::Push(), PCB_GRID_HELPER::queryVisible(), MULTICHANNEL_TOOL::setPreviewHidden(), ALLEGRO::BOARD_BUILDER::stampIds(), BOARD_ITEM_INDEX::UnbindChildren(), BOARD_ITEM_INDEX::UnbindSubtree(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), KIGFX::PCB_VIEW::Update(), PCB_SELECTION::updateDrawList(), and MULTICHANNEL_TOOL::UpdateRepeatPreview().

◆ Scale()

void PCB_SHAPE::Scale ( double aScale )

Definition at line 818 of file pcb_shape.cpp.

References scale.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex().

◆ scale()

void EDA_SHAPE::scale ( double aScale )

protectedinherited

Definition at line 1024 of file eda_shape.cpp.

References std::abs(), ARC, BEZIER, CIRCLE, ELLIPSE, ELLIPSE_ARC, getMaxError(), GetPolyShape(), KI_FALLTHROUGH, KiROUND(), m_arcCenter, m_bezierC1, m_bezierC2, m_ellipse, m_end, m_hatchingDirty, m_shape, m_start, SHAPE_POLY_SET::OutlineCount(), POLY, RebuildBezierToSegmentsPointsList(), recalcEllipseArcEndpoints(), RECTANGLE, SEGMENT, SetPolyPoints(), SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

◆ Serialize() [1/3]

void EDA_SHAPE::Serialize	(	google::protobuf::Any &	aContainer,
		const EDA_IU_SCALE &	aScale ) const

inherited

Definition at line 355 of file eda_shape.cpp.

References Serialize().

◆ Serialize() [2/3]

void EDA_SHAPE::Serialize	(	kiapi::common::types::GraphicShape &	aOutput,
		const EDA_IU_SCALE &	aScale ) const

inherited

◆ Serialize() [3/3]

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_TABLECELL, and PCB_TEXTBOX.

Definition at line 287 of file pcb_shape.cpp.

References BOARD_ITEM::GetBoard(), GetLayer(), GetLocalSolderMaskMargin(), BOARD_ITEM::GetParentFootprint(), EDA_SHAPE::GetShape(), HasSolderMask(), BOARD_ITEM::IsLocked(), IsProxyItem(), EDA_ITEM::m_Uuid, kiapi::common::PackCustomProperties(), BOARD_CONNECTED_ITEM::PackNet(), pcbIUScale, RECTANGLE, SEGMENT, EDA_SHAPE::Serialize(), and ToProtoEnum().

◆ Set() [1/4]

template<typename T>

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

inherited

Definition at line 48 of file inspectable_impl.h.

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

◆ Set() [2/4]

template<typename T>

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

inherited

Definition at line 31 of file inspectable_impl.h.

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

◆ Set() [3/4]

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

inherited

Definition at line 28 of file inspectable.cpp.

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

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

◆ Set() [4/4]

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

inherited

Definition at line 45 of file inspectable.cpp.

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

◆ SetArcAngle()

void PCB_SHAPE::SetArcAngle ( const EDA_ANGLE & aAngle )

inlineoverridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 115 of file pcb_shape.h.

References EDA_SHAPE::SetArcAngle(), and syncLibCoords().

◆ SetArcAngleAndEnd()

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

inline

Definition at line 109 of file pcb_shape.h.

References EDA_SHAPE::SetArcAngleAndEnd(), and syncLibCoords().

Referenced by PCAD2KICAD::PCAD_ARC::AddToBoard(), ALTIUM_PCB::ConvertArcs6ToPcbShape(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), PCB_IO_EAGLE::loadPlain(), ARC_GEOM_SYNCER::OnCSAChange(), PCB_IO_EAGLE::packageWire(), PCB_IO_GEDA::parseElement(), GPCB_FPL_CACHE::parseFOOTPRINT(), PCB_IO_GEDA::parseLayer(), and SPRINT_LAYOUT_PARSER::processCircle().

◆ SetArcGeometry()

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

overridevirtual

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.

Reimplemented from EDA_SHAPE.

Definition at line 1402 of file pcb_shape.cpp.

References EDA_SHAPE::SetArcGeometry(), and syncLibCoords().

Referenced by KI_TEST::addArc(), TARGET3001_PCB_BUILDER::addShape(), FEATURES_MANAGER::AddTrack(), applyGeometry(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), buildShapes(), ConnectBoardShapes(), DIPTRACE::PCB_PARSER::CreateFootprint(), CONVERT_TOOL::CreateLines(), PCB_IO_AUTOTRAX::emitArc(), PCB_IO_IPC2581::generateLayerSetNet(), makeArc(), makeArc(), ARC_GEOM_SYNCER::OnCRAAChange(), ARC_GEOM_SYNCER::OnSMEChange(), CONVERT_TOOL::SegmentToArc(), and PCB_IO_PADS_BINARY::setBoardOutlineArc().

◆ SetArcOrSegment()

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

inherited

Set the shape from three points, falling back to a SEGMENT from aStart to aEnd when the points are collinear and so have no finite arc center.

Definition at line 1416 of file eda_shape.cpp.

References IsStraightArc(), SEGMENT, SetArcGeometry(), SetEnd(), SetShape(), and SetStart().

Referenced by DIPTRACE::PCB_PARSER::CreateBoardOutline().

◆ SetBezierC1()

void PCB_SHAPE::SetBezierC1 ( const VECTOR2I & aPt )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1409 of file pcb_shape.cpp.

References EDA_SHAPE::SetBezierC1(), and syncLibCoords().

Referenced by KI_TEST::addBezier(), TARGET3001_PCB_BUILDER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ConnectBoardShapes(), makeBezierChain(), and BEZIER_GEOM_SYNCER::OnBezierChange().

◆ SetBezierC2()

void PCB_SHAPE::SetBezierC2 ( const VECTOR2I & aPt )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1416 of file pcb_shape.cpp.

References EDA_SHAPE::SetBezierC2(), and syncLibCoords().

Referenced by KI_TEST::addBezier(), TARGET3001_PCB_BUILDER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ConnectBoardShapes(), makeBezierChain(), and BEZIER_GEOM_SYNCER::OnBezierChange().

◆ SetBottom()

virtual void EDA_SHAPE::SetBottom ( int val )

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 370 of file eda_shape.h.

References SetEndY().

Referenced by BOOST_FIXTURE_TEST_CASE().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 151 of file eda_item.h.

References BRIGHTENED, and SetFlags().

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

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

Definition at line 1406 of file eda_shape.cpp.

References m_arcMidData.

Referenced by SetArcGeometry().

◆ SetCenter()

void PCB_SHAPE::SetCenter ( const VECTOR2I & aCenter )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1024 of file pcb_shape.cpp.

References EDA_SHAPE::SetCenter(), and syncLibCoords().

Referenced by TARGET3001_PCB_BUILDER::addShape(), PCAD2KICAD::PCAD_ARC::AddToBoard(), ALTIUM_PCB::ConvertArcs6ToPcbShape(), DIPTRACE::PCB_PARSER::CreateFootprint(), PCB_IO_AUTOTRAX::emitArc(), CADSTAR_PCB_ARCHIVE_LOADER::getShapeFromVertex(), GRAPH_CONNECTION::GetShapes(), PCB_IO_PADS::loadFootprints(), PCB_IO_PADS::loadGraphicLines(), PCB_IO_PADS_BINARY::loadGraphicLines(), PCB_IO_EAGLE::loadPlain(), CIRCLE_GEOM_SYNCER::OnCenterPointChange(), CIRCLE_GEOM_SYNCER::OnCenterRadiusChange(), ARC_GEOM_SYNCER::OnCSAChange(), PCB_IO_EAGLE::packageWire(), PCB_IO_GEDA::parseElement(), GPCB_FPL_CACHE::parseFOOTPRINT(), PCB_IO_GEDA::parseLayer(), SPRINT_LAYOUT_PARSER::processCircle(), CONVERT_TOOL::SegmentToArc(), and PCB_IO_PADS::setPcbShapeArc().

◆ SetCenterX()

void EDA_SHAPE::SetCenterX ( int x )

inlineinherited

Definition at line 319 of file eda_shape.h.

References m_end, m_hatchingDirty, m_start, SetEnd(), SetStart(), and VECTOR2< T >::x.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ SetCenterY()

void EDA_SHAPE::SetCenterY ( int y )

inlineinherited

Definition at line 308 of file eda_shape.h.

References m_end, m_hatchingDirty, m_start, SetEnd(), SetStart(), and VECTOR2< T >::y.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ SetCornerRadius()

void PCB_SHAPE::SetCornerRadius ( int aCornerRadius )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1031 of file pcb_shape.cpp.

References EDA_SHAPE::SetCornerRadius(), and syncLibCoords().

Referenced by addTransformFeatures(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), FabMaskShape(), and roundedRectToPolygon().

◆ SetCustomProperties()

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

inlineinherited

Definition at line 247 of file eda_item.h.

References m_customProperties, and SetCustomProperty().

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

◆ SetCustomProperty()

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

inlineinherited

◆ SetEditState()

void PCB_SHAPE::SetEditState ( int aState )

inline

Definition at line 107 of file pcb_shape.h.

References EDA_SHAPE::setEditState().

Referenced by DRAWING_TOOL::drawShape().

◆ setEditState()

void EDA_SHAPE::setEditState ( int aState )

inlineprotectedinherited

Definition at line 710 of file eda_shape.h.

References m_editState.

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

◆ SetEllipseCenter()

void PCB_SHAPE::SetEllipseCenter ( const VECTOR2I & aPt )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1430 of file pcb_shape.cpp.

References EDA_SHAPE::SetEllipseCenter(), and syncLibCoords().

Referenced by KI_TEST::addEllipse(), KI_TEST::addEllipseArc(), addTransformFeatures(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ELLIPSE_ARC_GEOM_SYNCER::OnChange(), ELLIPSE_GEOM_SYNCER::OnChange(), rebakeFromTransform(), and updateSegmentFromGeometryMgr().

◆ SetEllipseEndAngle()

void PCB_SHAPE::SetEllipseEndAngle ( const EDA_ANGLE & aA )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1465 of file pcb_shape.cpp.

References EDA_SHAPE::SetEllipseEndAngle(), and syncLibCoords().

Referenced by KI_TEST::addEllipseArc(), addTransformFeatures(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ELLIPSE_ARC_GEOM_SYNCER::OnChange(), rebakeFromTransform(), and updateSegmentFromGeometryMgr().

◆ SetEllipseMajorRadius()

void PCB_SHAPE::SetEllipseMajorRadius ( int aR )

overridevirtual

◆ SetEllipseMinorRadius()

void PCB_SHAPE::SetEllipseMinorRadius ( int aR )

overridevirtual

◆ SetEllipseRotation()

void PCB_SHAPE::SetEllipseRotation ( const EDA_ANGLE & aA )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1451 of file pcb_shape.cpp.

References EDA_SHAPE::SetEllipseRotation(), and syncLibCoords().

Referenced by KI_TEST::addEllipse(), KI_TEST::addEllipseArc(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ELLIPSE_ARC_GEOM_SYNCER::OnChange(), ELLIPSE_GEOM_SYNCER::OnChange(), rebakeFromTransform(), and updateSegmentFromGeometryMgr().

◆ SetEllipseStartAngle()

void PCB_SHAPE::SetEllipseStartAngle ( const EDA_ANGLE & aA )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1458 of file pcb_shape.cpp.

References EDA_SHAPE::SetEllipseStartAngle(), and syncLibCoords().

Referenced by KI_TEST::addEllipseArc(), addTransformFeatures(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ELLIPSE_ARC_GEOM_SYNCER::OnChange(), rebakeFromTransform(), and updateSegmentFromGeometryMgr().

◆ SetEnd()

void PCB_SHAPE::SetEnd ( const VECTOR2I & aEnd )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1017 of file pcb_shape.cpp.

References EDA_SHAPE::SetEnd(), and syncLibCoords().

◆ SetEndEnding()

void EDA_SHAPE::SetEndEnding ( const LINE_ENDING & aEnding )

inlineinherited

Definition at line 189 of file eda_shape.h.

References m_endEnding.

Referenced by addTransformFeatures(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), clearLineEndings(), and lineEndingShape().

◆ SetEndEndingLength()

void EDA_SHAPE::SetEndEndingLength ( int aLength )

inlineinherited

◆ SetEndEndingStrokeWidth()

void EDA_SHAPE::SetEndEndingStrokeWidth ( int aWidth )

inlineinherited

Definition at line 210 of file eda_shape.h.

References m_endEnding.

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

◆ SetEndEndingStyle()

void EDA_SHAPE::SetEndEndingStyle ( LINE_ENDING_STYLE aStyle )

inlineinherited

◆ SetEndEndingWidth()

void EDA_SHAPE::SetEndEndingWidth ( int aWidth )

inlineinherited

◆ SetEndX()

void EDA_SHAPE::SetEndX ( int aX )

inlineinherited

Definition at line 351 of file eda_shape.h.

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

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), SCH_SHAPE::Normalize(), PCB_TEXTBOX::SetLeft(), SetRectangleWidth(), SetRight(), and PCB_TEXTBOX::SetRight().

◆ SetEndY()

void EDA_SHAPE::SetEndY ( int aY )

inlineinherited

Definition at line 344 of file eda_shape.h.

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

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), SCH_SHAPE::Normalize(), SetBottom(), PCB_TEXTBOX::SetBottom(), SetRectangleHeight(), and PCB_TEXTBOX::SetTop().

◆ SetFillColor()

void EDA_SHAPE::SetFillColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 162 of file eda_shape.h.

References m_fillColor.

Referenced by SCH_IO_ALTIUM::AddLibTextBox(), SCH_IO_ALTIUM::AddTextBox(), Deserialize(), SCH_TEXTBOX::Deserialize(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), fixupSchFillMode(), lineEndingPolygons(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_KICAD_SEXPR_PARSER::parseEllipseBody(), SCH_IO_KICAD_SEXPR_PARSER::parseSchTextBoxContent(), ORCAD_CONVERTER::placeHierarchicalBlockPinFill(), SCH_TABLECELL_DESC::SCH_TABLECELL_DESC(), SetLibShapeFillAndColor(), SetSchShapeFillAndColor(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetFilled()

virtual void EDA_SHAPE::SetFilled ( bool aFlag )

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 144 of file eda_shape.h.

References setFilled().

Referenced by FEATURES_MANAGER::AddDimension(), PAD::AddPrimitivePoly(), PAD::AddPrimitivePoly(), TARGET3001_PCB_BUILDER::addShape(), EASYPC_PCB::AddShapeItem(), altiumMakePadLayerCustom(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ALLEGRO::BOARD_BUILDER::buildFootprint(), TARGET3001_PCB_BUILDER::buildSignalCopper(), ZONE_CREATE_HELPER::commitZone(), ALTIUM_PCB::ConvertFills6ToBoardItem(), ALTIUM_PCB::ConvertFills6ToFootprintItem(), ALTIUM_PCB::ConvertFills6ToPcbShape(), DRAWING_TOOL::ConvertImageToOutlines(), DIPTRACE::PCB_PARSER::CreateFootprint(), CONVERT_TOOL::CreateLines(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawShape(), PCB_IO_AUTOTRAX::emitFill(), ALTIUM_PCB::HelperParsePad6NonCopper(), PCB_IO_PADS_BINARY::loadCopperShapes(), FABMASTER::loadGraphics(), PCB_IO_EAGLE::loadPlain(), FABMASTER::loadPolygon(), PCB_IO_PADS_BINARY::loadZones(), CONVERT_TOOL::makePolysFromClosedGraphics(), GRAPHICS_CLEANER::mergeRects(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), SPRINT_LAYOUT_PARSER::processPoly(), PAD::Recombine(), DRAWING_TOOL::runSimpleShapeDraw(), 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 673 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 708 of file eda_shape.cpp.

References m_fill, and m_hatchingDirty.

◆ SetFillModeProp()

void EDA_SHAPE::SetFillModeProp ( UI_FILL_MODE aFill )

inherited

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

References m_flags.

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 162 of file view_item.h.

References m_forcedTransparency.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 232 of file eda_item.h.

References m_forceVisible.

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

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 470 of file board_item.cpp.

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

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

◆ SetHasSolderMask()

void PCB_SHAPE::SetHasSolderMask ( bool aVal )

inline

Definition at line 346 of file pcb_shape.h.

References m_hasSolderMask.

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

◆ SetHatchingDirty()

void EDA_SHAPE::SetHatchingDirty ( )

inlineinherited

Definition at line 155 of file eda_shape.h.

References m_hatchingDirty.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_POINT_EDITOR::removeCorner(), and SCH_POINT_EDITOR::Reset().

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Reimplemented in PCB_BARCODE.

Definition at line 424 of file board_item.h.

References m_isKnockout.

Referenced by ZONE_FILLER::addKnockout(), addTransformFeatures(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ALTIUM_PCB::ConvertTexts6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), MULTICHANNEL_TOOL::copyRuleAreaContents(), PCB_BARCODE::Deserialize(), PCB_TEXT::Deserialize(), PCB_TEXTBOX::Deserialize(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_V3_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(), processTextItem(), PCB_BARCODE::SetIsKnockout(), and PCB_FIELDS_GRID_TABLE::SetValueAsBool().

◆ SetIsProxyItem()

void PCB_SHAPE::SetIsProxyItem ( bool aIsProxy = true )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1587 of file pcb_shape.cpp.

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

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parsePAD_primitives(), and PCB_SHAPE_DESC::PCB_SHAPE_DESC().

◆ SetIsRollover()

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

inlineinherited

Definition at line 144 of file eda_item.h.

References m_isRollover, and m_rolloverPos.

Referenced by SCH_SELECTION_TOOL::Main().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 198 of file eda_item.h.

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

◆ SetLayer()

void PCB_SHAPE::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtual

Set the layer this item is on.

Parameters

aLayer The layer number.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 444 of file pcb_shape.cpp.

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

◆ SetLayerSet()

void PCB_SHAPE::SetLayerSet ( const LSET & aLayers )

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 520 of file pcb_shape.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE().

◆ SetLeft()

virtual void EDA_SHAPE::SetLeft ( int val )

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 368 of file eda_shape.h.

References SetStartX().

◆ SetLibraryEllipse()

void PCB_SHAPE::SetLibraryEllipse	(	const VECTOR2I &	aCenter,
		int	aMajor,
		int	aMinor,
		const EDA_ANGLE &	aRotation,
		const EDA_ANGLE &	aStartAngle,
		const EDA_ANGLE &	aEndAngle )

inline

Definition at line 244 of file pcb_shape.h.

References m_libEllipseCenter, m_libEllipseEndAngle, m_libEllipseMajorRadius, m_libEllipseMinorRadius, m_libEllipseRotation, m_libEllipseStartAngle, EDA_SHAPE::SetEllipseCenter(), EDA_SHAPE::SetEllipseEndAngle(), EDA_SHAPE::SetEllipseMajorRadius(), EDA_SHAPE::SetEllipseMinorRadius(), EDA_SHAPE::SetEllipseRotation(), and EDA_SHAPE::SetEllipseStartAngle().

◆ SetLibStrokeWidth()

void PCB_SHAPE::SetLibStrokeWidth ( int aWidth )

Definition at line 1058 of file pcb_shape.cpp.

References EDA_SHAPE::m_hatchingDirty, and EDA_SHAPE::m_stroke.

◆ SetLineColor()

void EDA_SHAPE::SetLineColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 173 of file eda_shape.h.

References m_stroke.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), and SCH_SCREEN::Plot().

◆ SetLineStyle()

void EDA_SHAPE::SetLineStyle ( const LINE_STYLE aStyle )

inherited

Definition at line 3844 of file eda_shape.cpp.

References m_stroke.

Referenced by BOOST_AUTO_TEST_CASE(), SCH_TEXTBOX::Deserialize(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadShapeVertices(), lowerLineEndingShape(), 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 208 of file board_connected_item.h.

References m_localRatsnestVisible.

Referenced by BOARD::ExchangeFootprint().

◆ SetLocalSolderMaskMargin()

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

inline

Definition at line 349 of file pcb_shape.h.

References m_solderMaskMargin.

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

◆ SetLocked()

void BOARD_ITEM::SetLocked ( bool aLocked )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Reimplemented in PCB_GROUP.

Definition at line 427 of file board_item.h.

References m_isLocked.

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 260 of file eda_item.cpp.

References IS_CHANGED, m_parent, and SetFlags().

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

◆ SetNet()

virtual void BOARD_CONNECTED_ITEM::SetNet ( NETINFO_ITEM * aNetInfo )

inlinevirtualinherited

Set a NET_INFO object for the item.

Subclasses with a netless invariant (e.g. ZONE in copper-thieving mode) override this to drop aNetInfo before storing it. Direct callers of SetNet bypass the SetNetCode clamp, so this hook is essential.

Reimplemented in ZONE.

Definition at line 93 of file board_connected_item.h.

References m_netinfo.

◆ SetNetCode() [1/2]

void BOARD_CONNECTED_ITEM::SetNetCode ( int aNetCode )

inlineinherited

Definition at line 128 of file board_connected_item.h.

References SetNetCode().

◆ SetNetCode() [2/2]

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

virtualinherited

Set net using a net code.

Subclasses that enforce a netless invariant (e.g. ZONE in copper-thieving mode) override this to clamp aNetCode before it reaches the base routine. The non-virtual overload below routes through this one, so callers that reach the setter via a BOARD_CONNECTED_ITEM* still hit the clamp.

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

Reimplemented in ZONE.

Definition at line 85 of file board_connected_item.cpp.

References BOARD::FindNet(), BOARD_ITEM::GetBoard(), EDA_ITEM::GetFlags(), BOARD::InvalidateClearanceCache(), BOARD_ITEM::IsOnCopperLayer(), m_netinfo, EDA_ITEM::m_Uuid, NETINFO_LIST::OrphanedItem(), and ROUTER_TRANSIENT.

◆ SetNetHighlighted()

void EDA_ITEM::SetNetHighlighted ( bool aHighlighted )

inherited

Definition at line 131 of file eda_item.cpp.

References m_netHighlighted.

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

◆ SetParent()

void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

virtualinherited

Reimplemented in LIB_SYMBOL, NETINFO_ITEM, and PCB_POINT.

Definition at line 153 of file eda_item.cpp.

References EDA_ITEM(), and m_parent.

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

◆ SetPolyPoints()

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

inherited

◆ SetPolyShape()

void PCB_SHAPE::SetPolyShape ( const SHAPE_POLY_SET & aShape )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1423 of file pcb_shape.cpp.

References EDA_SHAPE::SetPolyShape(), and syncLibCoords().

◆ SetPosition()

void PCB_SHAPE::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 77 of file pcb_shape.h.

References EDA_SHAPE::setPosition().

Referenced by 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 525 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 358 of file eda_shape.h.

References m_hatchingDirty, m_start, and SetEnd().

Referenced by TARGET3001_PCB_BUILDER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), FabMaskShape(), and CIRCLE_GEOM_SYNCER::OnCenterRadiusChange().

◆ SetRectangle()

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

inherited

Definition at line 660 of file eda_shape.cpp.

References m_shape, RECTANGLE, SetRectangleHeight(), SetRectangleWidth(), SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

◆ SetRectangleHeight()

void EDA_SHAPE::SetRectangleHeight ( const int & aHeight )

inherited

Definition at line 630 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(), FabMaskShape(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), PCB_TABLECELL::PCB_TABLECELL(), and SetRectangle().

◆ SetRectangleWidth()

void EDA_SHAPE::SetRectangleWidth ( const int & aWidth )

inherited

Definition at line 645 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(), FabMaskShape(), TEST_BOARD_ITEM_FIXTURE::Instantiate(), PCB_TABLECELL::PCB_TABLECELL(), and SetRectangle().

◆ SetRight()

virtual void EDA_SHAPE::SetRight ( int val )

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 369 of file eda_shape.h.

References SetEndX().

Referenced by BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), and BOOST_FIXTURE_TEST_CASE().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 150 of file eda_item.h.

References SELECTED, and SetFlags().

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

◆ SetShape()

void PCB_SHAPE::SetShape ( SHAPE_T aShape )

inlineoverridevirtual

Reimplemented from EDA_SHAPE.

Reimplemented in PCB_TEXTBOX.

Definition at line 212 of file pcb_shape.h.

References m_libShape, and EDA_SHAPE::SetShape().

Referenced by FEATURES_MANAGER::AddDimension(), PAD::AddPrimitivePoly(), applyGeometry(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SPRINT_LAYOUT_PARSER::buildOutline(), ZONE_CREATE_HELPER::commitZone(), ALTIUM_PCB::ConvertArcs6ToPcbShape(), ALTIUM_PCB::ConvertFills6ToPcbShape(), DRAWING_TOOL::ConvertImageToOutlines(), DIPTRACE::PCB_PARSER::CreateFootprint(), CONVERT_TOOL::CreatePolys(), DRAWING_TOOL::DrawLine(), DRAWING_TOOL::DrawRectangle(), DRAWING_TOOL::drawShape(), ellipseToPolygon(), PCB_IO_AUTOTRAX::emitArc(), ALTIUM_PCB::HelperParsePad6NonCopper(), PCB_IO_PADS::loadBoardOutline(), PCB_IO_PADS_BINARY::loadBoardOutline(), PCB_IO_PADS::loadCopperShapes(), PCB_IO_PADS::loadFootprints(), PCB_IO_PADS::loadGraphicLines(), PCB_IO_PADS_BINARY::loadGraphicLines(), PCB_IO_EAGLE::loadPlain(), FABMASTER::loadPolygon(), lowerLineEndingShape(), GRAPHICS_CLEANER::mergeRects(), Normalize(), PCB_IO_GEDA::parseElement(), GPCB_FPL_CACHE::parseFOOTPRINT(), PCB_IO_GEDA::parseLayer(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), SPRINT_LAYOUT_PARSER::processCircle(), SPRINT_LAYOUT_PARSER::processLine(), SPRINT_LAYOUT_PARSER::processPoly(), SPRINT_LAYOUT_PARSER::processSegment(), roundedRectToPolygon(), DRAWING_TOOL::runSimpleShapeDraw(), PCB_IO_PADS_BINARY::setBoardOutlineArc(), and PCB_IO_PADS::setPcbShapeArc().

◆ SetStart()

void PCB_SHAPE::SetStart ( const VECTOR2I & aStart )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1010 of file pcb_shape.cpp.

References EDA_SHAPE::SetStart(), and syncLibCoords().

◆ SetStartEnding()

void EDA_SHAPE::SetStartEnding ( const LINE_ENDING & aEnding )

inlineinherited

Definition at line 183 of file eda_shape.h.

References m_startEnding.

Referenced by clearLineEndings(), and lineEndingShape().

◆ SetStartEndingLength()

void EDA_SHAPE::SetStartEndingLength ( int aLength )

inlineinherited

◆ SetStartEndingStrokeWidth()

void EDA_SHAPE::SetStartEndingStrokeWidth ( int aWidth )

inlineinherited

Definition at line 208 of file eda_shape.h.

References m_startEnding.

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC().

◆ SetStartEndingStyle()

void EDA_SHAPE::SetStartEndingStyle ( LINE_ENDING_STYLE aStyle )

inlineinherited

◆ SetStartEndingWidth()

void EDA_SHAPE::SetStartEndingWidth ( int aWidth )

inlineinherited

◆ SetStartX()

void EDA_SHAPE::SetStartX ( int x )

inlineinherited

Definition at line 301 of file eda_shape.h.

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

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), SCH_SHAPE::Normalize(), SetLeft(), PCB_TEXTBOX::SetLeft(), and PCB_TEXTBOX::SetRight().

◆ SetStartY()

void EDA_SHAPE::SetStartY ( int y )

inlineinherited

Definition at line 294 of file eda_shape.h.

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

Referenced by EDA_SHAPE_DESC::EDA_SHAPE_DESC(), SCH_SHAPE::Normalize(), PCB_TEXTBOX::SetBottom(), SetTop(), and PCB_TEXTBOX::SetTop().

◆ SetStroke()

void PCB_SHAPE::SetStroke ( const STROKE_PARAMS & aStroke )

overridevirtual

Reimplemented from BOARD_ITEM.

Definition at line 1073 of file pcb_shape.cpp.

References STROKE_PARAMS::GetWidth(), EDA_SHAPE::m_stroke, and SetWidth().

Referenced by FEATURES_MANAGER::AddDimension(), PAD::AddPrimitivePoly(), PAD::AddPrimitivePoly(), TARGET3001_PCB_BUILDER::addShape(), EASYPC_PCB::AddShapeItem(), PCAD2KICAD::PCAD_ARC::AddToBoard(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_POLYGON::AddToBoard(), altiumMakePadLayerCustom(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), TARGET3001_PCB_BUILDER::buildSignalCopper(), ZONE_CREATE_HELPER::commitZone(), ALTIUM_PCB::ConvertArcs6ToBoardItem(), ALTIUM_PCB::ConvertArcs6ToFootprintItem(), ALTIUM_PCB::ConvertFills6ToBoardItem(), ALTIUM_PCB::ConvertFills6ToFootprintItem(), ALTIUM_PCB::ConvertFills6ToPcbShape(), DRAWING_TOOL::ConvertImageToOutlines(), ALTIUM_PCB::ConvertTracks6ToBoardItem(), ALTIUM_PCB::ConvertTracks6ToFootprintItem(), DIPTRACE::PCB_PARSER::CreateBoardOutline(), MICROWAVE_TOOL::createMicrowaveInductor(), MICROWAVE_TOOL::createPolygonShape(), CONVERT_TOOL::CreatePolys(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), DRAWING_TOOL::drawManagedShape(), DRAWING_TOOL::drawShape(), PCB_MARKER::GetErrorLegendShapes(), ALTIUM_PCB::HelperParsePad6NonCopper(), PCB_IO_PADS::loadCopperShapes(), FABMASTER::loadFootprints(), PCB_IO_PADS::loadFootprints(), FABMASTER::loadGraphics(), CADSTAR_PCB_ARCHIVE_LOADER::loadNetTracks(), PCB_IO_EAGLE::loadPlain(), FABMASTER::loadPolygon(), GRAPHICS_CLEANER::mergeRects(), PCB_IO_EAGLE::packageCircle(), PCB_IO_EAGLE::packagePolygon(), PCB_IO_EAGLE::packageRectangle(), PCB_IO_EAGLE::packageWire(), PCB_IO_GEDA::parseElement(), GPCB_FPL_CACHE::parseFOOTPRINT(), PCB_IO_GEDA::parseLayer(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), BRDITEMS_PLOTTER::PlotDimension(), BRDITEMS_PLOTTER::PlotPcbTarget(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), PAD::Recombine(), and CONVERT_TOOL::SegmentToArc().

◆ SetTeardropAllowSpanTwoTracks()

void BOARD_CONNECTED_ITEM::SetTeardropAllowSpanTwoTracks ( bool aAllow )

inlineinherited

Definition at line 235 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropBestLengthRatio()

void BOARD_CONNECTED_ITEM::SetTeardropBestLengthRatio ( double aRatio )

inlineinherited

Definition at line 217 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropBestWidthRatio()

void BOARD_CONNECTED_ITEM::SetTeardropBestWidthRatio ( double aRatio )

inlineinherited

Definition at line 223 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropCurved()

void BOARD_CONNECTED_ITEM::SetTeardropCurved ( bool aCurve )

inlineinherited

Definition at line 229 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropMaxLength()

void BOARD_CONNECTED_ITEM::SetTeardropMaxLength ( int aMaxLength )

inlineinherited

Definition at line 220 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropMaxTrackWidth()

void BOARD_CONNECTED_ITEM::SetTeardropMaxTrackWidth ( double aRatio )

inlineinherited

Definition at line 238 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropMaxWidth()

void BOARD_CONNECTED_ITEM::SetTeardropMaxWidth ( int aMaxWidth )

inlineinherited

Definition at line 226 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropPreferZoneConnections()

void BOARD_CONNECTED_ITEM::SetTeardropPreferZoneConnections ( bool aPrefer )

inlineinherited

Definition at line 232 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC().

◆ SetTeardropsEnabled()

void BOARD_CONNECTED_ITEM::SetTeardropsEnabled ( bool aEnable )

inlineinherited

Definition at line 214 of file board_connected_item.h.

References m_teardropParams.

Referenced by BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), PAD::Deserialize(), and PCB_VIA::Deserialize().

◆ SetTop()

virtual void EDA_SHAPE::SetTop ( int val )

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 367 of file eda_shape.h.

References SetStartY().

Referenced by BOOST_FIXTURE_TEST_CASE(), and BOOST_FIXTURE_TEST_CASE().

◆ SetUuid()

void BOARD_ITEM::SetUuid ( const KIID & aUuid )

inherited

Definition at line 121 of file board_item.cpp.

References BOARD_ITEM_INDEX, m_owningIndex, EDA_ITEM::m_Uuid, and SetUuidDirect().

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

◆ SetUuidDirect()

void BOARD_ITEM::SetUuidDirect ( const KIID & aUuid )

inherited

Raw UUID assignment.

No board index maintenance.

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

Definition at line 138 of file board_item.cpp.

References EDA_ITEM::m_Uuid.

◆ SetWidth()

void PCB_SHAPE::SetWidth ( int aWidth )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 1045 of file pcb_shape.cpp.

References fpScaleLinear(), KiROUND(), EDA_SHAPE::m_hatchingDirty, EDA_SHAPE::m_stroke, and transformFp().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 156 of file board_item.h.

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

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

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 162 of file board_item.h.

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

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

◆ SHAPE_T_asString()

wxString EDA_SHAPE::SHAPE_T_asString ( ) const

inherited

Definition at line 506 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, ELLIPSE, ELLIPSE_ARC, m_shape, POLY, RECTANGLE, SEGMENT, and UNDEFINED.

Referenced by SCH_SHAPE::AddPoint(), BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), beginEdit(), calcEdit(), CheckLibSymbolGraphics(), continueEdit(), endEdit(), flip(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_WRITER_V10::format(), PCB_WRITER_V10::format(), PCB_WRITER_V9::format(), PCB_WRITER_V9::format(), getBoundingBox(), getCenter(), PCB_SHAPE::GetConnectionPoints(), PCB_SHAPE::GetCorners(), SCH_SHAPE::GetItemDescription(), GetLength(), SCH_SHAPE::GetMenuImage(), GetRadius(), GetRectangleHeight(), GetRectangleWidth(), hitTest(), hitTest(), IsClockwiseArc(), IsClosed(), GRAPHICS_CLEANER::isNullShape(), libSaveSymbolDrawItem(), libSaveSymbolDrawItem(), makeEffectiveShapes(), SCH_POINT_EDITOR::makePointsAndBehavior(), move(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), rotate(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), SCH_IO_KICAD_SEXPR::saveShape(), SCH_WRITER_V10::saveShape(), SCH_WRITER_V9::saveShape(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveSymbolDrawItem(), scale(), SetCenter(), SetRectangle(), SetRectangleHeight(), SetRectangleWidth(), shapeNeedsUpdate(), TransformShapeToPolygon(), and UpdateHatching().

◆ ShapeGetMsgPanelInfo()

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

inherited

◆ ShortenArcForEndings()

bool EDA_SHAPE::ShortenArcForEndings	(	EDA_ANGLE &	aStartAngle,
		EDA_ANGLE &	aArcAngle,
		double	aRadius,
		int	aLineWidth ) const

inherited

Shorten an arc body for line endings.

Returns: false if the line endings consume the whole arc body.

Definition at line 4310 of file eda_shape.cpp.

References std::abs(), ANGLE_0, EDA_ANGLE::AsRadians(), DEGREES_T, m_endEnding, m_startEnding, and RAD2DEG().

Referenced by BOARD_ADAPTER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::PCB_PAINTER::draw(), makeShortenedBodyShapes(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), and TransformWithLineEndingsToPolygon().

◆ ShortenBodyPolyPoints()

bool EDA_SHAPE::ShortenBodyPolyPoints	(	std::vector< VECTOR2I > &	aPoints,
		int	aOutlineIdx,
		int	aLineWidth ) const

inherited

Apply line-ending body shortening to copied/generated polyline points.

Line endings belong to the first open outline only. Other outlines are returned unchanged.

Returns: false if the outline is invalid or the line endings consume its body.

Definition at line 4517 of file eda_shape.cpp.

References IsClosed(), and ShortenPolyForEndings().

Referenced by GetShortenedBodyPolyPoints(), and SCH_SHAPE::Plot().

◆ ShortenedBezierCurve()

std::optional< BEZIER< double > > EDA_SHAPE::ShortenedBezierCurve ( int aLineWidth ) const

inherited

Return the cubic Bezier curve shortened for line endings.

The shortening distance is mapped onto the source curve using a fixed-cost numerical arc-length estimator, then the curve is subdivided with de Casteljau so curve-capable backends can keep a Bezier.

Definition at line 4423 of file eda_shape.cpp.

References BEZIER, bezierLength(), findBezierTAtLength(), GetEndEnding(), LINE_ENDING::GetShortenDepth(), GetStartEnding(), IsClosed(), m_bezierC1, m_bezierC2, m_end, m_shape, and m_start.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::PCB_PAINTER::draw(), GetEndingTangents(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), and ShortenedBezierPolyline().

◆ ShortenedBezierPolyline()

std::vector< VECTOR2D > EDA_SHAPE::ShortenedBezierPolyline ( int aLineWidth ) const

inherited

Return the flattened Bezier polyline after line-ending shortening.

Definition at line 4454 of file eda_shape.cpp.

References getMaxError(), BEZIER_POLY::GetPoly(), and ShortenedBezierCurve().

Referenced by BOARD_ADAPTER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), MakeEffectiveShapesForStroking(), makeShortenedBodyShapes(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), and TransformWithLineEndingsToPolygon().

◆ ShortenPolyForEndings()

bool EDA_SHAPE::ShortenPolyForEndings	(	VECTOR2D &	aFirst,
		VECTOR2D &	aLast,
		const VECTOR2D &	aSecond,
		const VECTOR2D &	aPenultimate,
		int	aLineWidth ) const

inherited

Definition at line 4473 of file eda_shape.cpp.

References m_endEnding, and m_startEnding.

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

◆ ShortenSegmentForEndings()

bool EDA_SHAPE::ShortenSegmentForEndings	(	VECTOR2I &	aStart,
		VECTOR2I &	aEnd,
		const LINE_ENDING &	aStartEnding,
		const LINE_ENDING &	aEndEnding,
		int	aLineWidth )

staticinherited

Shorten a segment body for line endings.

Static so SCH_LINE (which doesn't inherit EDA_SHAPE) can use it too.

Returns: false if the line endings consume the whole segment body.

Definition at line 4270 of file eda_shape.cpp.

References delta, LINE_ENDING::GetShortenDepth(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOARD_ADAPTER::addShape(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), makeShortenedBodyShapes(), SCH_LINE::Plot(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), and TransformWithLineEndingsToPolygon().

◆ ShowShape()

wxString EDA_SHAPE::ShowShape ( ) const

inherited

Definition at line 477 of file eda_shape.cpp.

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

◆ Similarity() [1/2]

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

inherited

Definition at line 3968 of file eda_shape.cpp.

References SHAPE_POLY_SET::CVertex(), EDA_SHAPE(), STROKE_PARAMS::GetLineStyle(), GetPolyShape(), GetShape(), STROKE_PARAMS::GetWidth(), alg::longest_common_subset(), m_arcCenter, m_bezierC1, m_bezierC2, m_bezierPoints, m_end, m_endEnding, m_fill, m_fillColor, m_start, m_startEnding, 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 1985 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 540 of file eda_item.h.

References EDA_ITEM().

◆ StyleFromSettings()

void PCB_SHAPE::StyleFromSettings	(	const BOARD_DESIGN_SETTINGS &	aSettings,
		bool	aCheckSide )

overridevirtual

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 735 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 1837 of file pcb_shape.cpp.

References BOARD_ITEM::BOARD_ITEM(), image, EDA_ITEM::m_customProperties, EDA_ITEM::m_flags, EDA_ITEM::m_forceVisible, m_hasSolderMask, BOARD_ITEM::m_isKnockout, BOARD_ITEM::m_isLocked, BOARD_ITEM::m_layer, m_libArcMid, m_libBezierC1, m_libBezierC2, m_libCornerRadius, m_libEllipseCenter, m_libEllipseEndAngle, m_libEllipseMajorRadius, m_libEllipseMinorRadius, m_libEllipseRotation, m_libEllipseStartAngle, m_libEnd, m_libPoly, m_libShape, m_libStart, 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 343 of file board_item.cpp.

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

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

◆ SwapShape()

void EDA_SHAPE::SwapShape ( EDA_SHAPE * aImage )

inherited

Definition at line 3521 of file eda_shape.cpp.

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

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

◆ syncLibCoords()

void PCB_SHAPE::syncLibCoords ( )

protectedvirtual

Reimplemented in PCB_TEXTBOX.

Definition at line 1472 of file pcb_shape.cpp.

References std::abs(), ARC, BEZIER, BOARD_ITEM::BOARD_ITEM(), ELLIPSE, ELLIPSE_ARC, EDA_SHAPE::GetArcMid(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetCornerRadius(), EDA_SHAPE::GetEllipseCenter(), EDA_SHAPE::GetEllipseEndAngle(), EDA_SHAPE::GetEllipseMajorRadius(), EDA_SHAPE::GetEllipseMinorRadius(), EDA_SHAPE::GetEllipseRotation(), EDA_SHAPE::GetEllipseStartAngle(), EDA_SHAPE::GetEnd(), BOARD_ITEM::GetParent(), EDA_SHAPE::GetPolyShape(), TRANSFORM_TRS::GetRotate(), TRANSFORM_TRS::GetScaleX(), EDA_SHAPE::GetStart(), TRANSFORM_TRS::InverseApply(), TRANSFORM_TRS::InverseApplyLinearScale(), TRANSFORM_TRS::IsUniformScale(), KiROUND(), m_libArcMid, m_libBezierC1, m_libBezierC2, m_libCornerRadius, m_libEllipseCenter, m_libEllipseEndAngle, m_libEllipseMajorRadius, m_libEllipseMinorRadius, m_libEllipseRotation, m_libEllipseStartAngle, m_libEnd, m_libPoly, m_libStart, EDA_SHAPE::m_shape, PCB_PAD_T, POLY, RECTANGLE, TRANSFORM_TRS::SetScale(), transformFp(), transformPolyVertices(), and EDA_ITEM::Type().

Referenced by BeginEdit(), CalcEdit(), ContinueEdit(), EndEdit(), Flip(), Move(), Rotate(), SetArcAngle(), SetArcAngleAndEnd(), SetArcGeometry(), SetBezierC1(), SetBezierC2(), SetCenter(), SetCornerRadius(), SetEllipseCenter(), SetEllipseEndAngle(), SetEllipseMajorRadius(), SetEllipseMinorRadius(), SetEllipseRotation(), SetEllipseStartAngle(), SetEnd(), SetPolyShape(), SetStart(), and PCB_TEXTBOX::syncLibCoords().

◆ transformFp()

const FOOTPRINT * PCB_SHAPE::transformFp ( ) const

protected

Definition at line 716 of file pcb_shape.cpp.

References BOARD_ITEM::GetParent(), BOARD_ITEM::GetParentFootprint(), PCB_PAD_T, and EDA_ITEM::Type().

Referenced by Flip(), GetLibraryArcMid(), GetLibraryBezierC1(), GetLibraryBezierC2(), GetLibraryPolyShape(), GetWidth(), RebakeFromLib(), SetWidth(), and syncLibCoords().

◆ TransformLineEndingsToPolygon()

void EDA_SHAPE::TransformLineEndingsToPolygon	(	SHAPE_POLY_SET &	aBuffer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc,
		int	aLineWidth ) const

inherited

Append only the line-ending geometry associated with this shape to a polygon set.

Definition at line 2832 of file eda_shape.cpp.

References addLineEndingPolygon(), GetEndingTangents(), GetLineEndingEndpoints(), hasLineEnding(), m_endEnding, and m_startEnding.

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

◆ 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
includeFill

Definition at line 3623 of file eda_shape.cpp.

References SEG::A, std::abs(), SHAPE_POLY_SET::AddOutline(), ANGLE_0, SHAPE_POLY_SET::Append(), ARC, SHAPE_LINE_CHAIN::Arc(), SHAPE_LINE_CHAIN::ArcIndex(), SEG::B, BEZIER, buildShapeEllipse(), chain, CIRCLE, SHAPE_ELLIPSE::ConvertToPolyline(), ELLIPSE, ELLIPSE_ARC, ERROR_OUTSIDE, GetArcMid(), SHAPE_ARC::GetArcMid(), GetBezierC1(), GetBezierC2(), getBoundingBox(), BOX2< Vec >::GetCenter(), getCenter(), GetCornerRadius(), GetEnd(), GetHatching(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), SHAPE_LINE_CHAIN::GetPoint(), SHAPE_LINE_CHAIN::GetPointCount(), BEZIER_POLY::GetPoly(), GetPolyShape(), GetRadius(), GetRectangleHeight(), GetRectangleWidth(), GetRectCorners(), SHAPE_LINE_CHAIN::GetSegment(), GetStart(), GetWidth(), SHAPE_POLY_SET::Inflate(), SHAPE_LINE_CHAIN::IsArcSegment(), IsHatchedFill(), IsPolyShapeValid(), IsProxyItem(), IsSolidFill(), m_shape, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), POLY, RECTANGLE, ROUND_ALL_CORNERS, SEGMENT, SHAPE_LINE_CHAIN::SegmentCount(), SHAPE_LINE_CHAIN::SetClosed(), SHAPE_T_asString(), TransformArcToPolygon(), TransformCircleToPolygon(), TransformOvalToPolygon(), TransformRingToPolygon(), TransformRoundChamferedRectToPolygon(), ROUNDRECT::TransformToPolygon(), and UNIMPLEMENTED_FOR.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), OrcadHatchLines(), PCB_SHAPE::TransformShapeToPolygon(), PCB_SHAPE::TransformShapeToPolySet(), and TransformWithLineEndingsToPolygon().

◆ 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.
aLayer	is the layer the polygon exists on.
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 1922 of file pcb_shape.cpp.

References EDA_SHAPE::TransformShapeToPolygon().

Referenced by FEATURES_MANAGER::AddShape(), BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), BOARD::ConvertBrdLayerToPolygonalContours(), drawPcbShapeWithStyle(), ALTIUM_PCB::HelperFoldPendingCopper(), DSN::SPECCTRA_DB::makeIMAGE(), 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,
		KIGFX::RENDER_SETTINGS *	aRenderSettings = nullptr ) const

overridevirtual

Convert the item shape to a polyset.

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 1931 of file pcb_shape.cpp.

References EDA_SHAPE::TransformShapeToPolygon().

Referenced by EXPORTER_STEP::buildGraphic3DShape(), and FOOTPRINT::TransformFPShapesToPolySet().

◆ TransformWithLineEndingsToPolygon()

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

inherited

Convert the shape body shortened for line endings plus line-ending geometry to polygons.

Definition at line 2854 of file eda_shape.cpp.

References ARC, BEZIER, buildShapeEllipse(), CalcArcAngles(), chain, SHAPE_ELLIPSE::ConvertToPolyline(), SHAPE_POLY_SET::COutline(), ELLIPSE, ELLIPSE_ARC, end, SHAPE_ARC::GetArcMid(), GetEffectiveWidth(), GetEnd(), getMaxError(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), GetPolyShape(), GetRadius(), GetShortenedBodyPolyPoints(), GetStart(), GetWidth(), SHAPE_LINE_CHAIN::IsClosed(), IsHatchedFill(), IsPolyShapeValid(), IsProxyItem(), IsSolidFill(), m_arcCenter, m_endEnding, m_shape, m_startEnding, SHAPE_POLY_SET::OutlineCount(), SHAPE_LINE_CHAIN::PointCount(), POLY, RotatePoint(), SEGMENT, ShortenArcForEndings(), ShortenedBezierPolyline(), ShortenSegmentForEndings(), TransformArcToPolygon(), TransformLineEndingsToPolygon(), TransformOvalToPolygon(), and TransformShapeToPolygon().

Referenced by addItemPolysWithEndings(), addItemPolysWithEndings(), addItemPolysWithEndings(), ZONE_FILLER::addKnockout(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), EXPORTER_STEP::buildGraphic3DShape(), and lowerLineEndingShape().

◆ 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 59 of file board_connected_item.cpp.

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

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

Reimplemented from EDA_SHAPE.

Definition at line 630 of file pcb_shape.cpp.

References EDA_SHAPE::m_hatchingDirty, and EDA_SHAPE::UpdateHatching().

Referenced by KIGFX::PCB_PAINTER::draw(), and PCB_CONTROL::rehatchBoardItem().

◆ 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 1795 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 KIGFX::PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters

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

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

Definition at line 123 of file view_item.h.

References VIEW.

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

◆ ViewGetLayers()

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

overridevirtual

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

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

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_TEXTBOX.

Definition at line 1680 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_CONSTRAINT_SHADOW, 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 1629 of file pcb_shape.cpp.

References KIGFX::PCB_RENDER_SETTINGS::GetConstrainedItems(), KIGFX::RENDER_SETTINGS::GetHighContrast(), KIGFX::VIEW::GetPainter(), BOARD_ITEM::GetParentFootprint(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), KIGFX::PCB_PAINTER::GetSettings(), IsBackLayer(), IsFrontLayer(), KIGFX::VIEW::IsLayerVisibleCached(), LAYER_CONSTRAINT_SHADOW, LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, LAYER_LOCKED_ITEM_SHADOW, KIGFX::VIEW_ITEM::LOD_HIDE, KIGFX::VIEW_ITEM::LOD_SHOW, BOARD_ITEM::m_layer, and EDA_ITEM::m_Uuid.

◆ viewPrivData()

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

inlineinherited

◆ Visit()

INSPECT_RESULT EDA_ITEM::Visit	(	INSPECTOR	aInspector,
		void *	aTestData,
		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

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

Returns: INSPECT_RESULT INSPECT_RESULT::QUIT if the Iterator is to stop the scan, else INSPECT_RESULT::CONTINUE, and determined by the inspector.

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

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

References m_flags.

Referenced by SCH_SELECTION_TOOL::SelectMultiple().

Member Data Documentation

◆ LOD_HIDE

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

staticconstexprprotectedinherited

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

Definition at line 176 of file view_item.h.

◆ LOD_SHOW

double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

staticconstexprprotectedinherited

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

Definition at line 181 of file view_item.h.

◆ m_arcCenter

VECTOR2I EDA_SHAPE::m_arcCenter

protectedinherited

Definition at line 770 of file eda_shape.h.

Referenced by calcEdit(), computeArcBBox(), Deserialize(), PCB_SHAPE::Deserialize(), EDA_SHAPE(), flip(), GetArcMid(), getCenter(), GetRadius(), makeEffectiveShapes(), makeShortenedBodyShapes(), move(), operator=(), operator==(), recalcEllipseArcEndpoints(), rotate(), scale(), SetArcAngleAndEnd(), SetArcGeometry(), SetCenter(), Similarity(), SwapShape(), and TransformWithLineEndingsToPolygon().

◆ m_arcMidData

ARC_MID EDA_SHAPE::m_arcMidData

protectedinherited

Definition at line 771 of file eda_shape.h.

Referenced by Deserialize(), PCB_SHAPE::Deserialize(), EDA_SHAPE(), GetArcMid(), move(), operator=(), rotate(), SetArcGeometry(), and SetCachedArcData().

◆ m_bezierC1

VECTOR2I EDA_SHAPE::m_bezierC1

protectedinherited

Definition at line 773 of file eda_shape.h.

Referenced by buildBezierToSegmentsPointsList(), Compare(), Deserialize(), PCB_SHAPE::Deserialize(), EDA_SHAPE(), flip(), GetBezierC1(), GetEndingTangents(), hitTest(), hitTest(), move(), operator=(), operator==(), rotate(), scale(), SetBezierC1(), ShortenedBezierCurve(), Similarity(), and SwapShape().

◆ m_bezierC2

VECTOR2I EDA_SHAPE::m_bezierC2

protectedinherited

Definition at line 774 of file eda_shape.h.

Referenced by buildBezierToSegmentsPointsList(), Compare(), Deserialize(), PCB_SHAPE::Deserialize(), EDA_SHAPE(), flip(), GetBezierC2(), GetEndingTangents(), hitTest(), hitTest(), move(), operator=(), operator==(), rotate(), scale(), SetBezierC2(), ShortenedBezierCurve(), Similarity(), and SwapShape().

◆ m_bezierPoints

std::vector<VECTOR2I> EDA_SHAPE::m_bezierPoints

protectedinherited

Definition at line 776 of file eda_shape.h.

Referenced by Compare(), EDA_SHAPE(), GetBezierPoints(), getBoundingBox(), SCH_SHAPE::GetItemDescription(), GetLength(), hitTest(), hitTest(), IsClosed(), move(), operator=(), operator==(), RebuildBezierToSegmentsPointsList(), rotate(), Similarity(), and SwapShape().

◆ m_blankEnding

LINE_ENDING EDA_SHAPE::m_blankEnding

protectedinherited

Definition at line 756 of file eda_shape.h.

Referenced by GetEndEnding(), and GetStartEnding().

◆ m_cornerRadius

int EDA_SHAPE::m_cornerRadius

protectedinherited

Definition at line 765 of file eda_shape.h.

Referenced by Compare(), EDA_SHAPE(), EDA_SHAPE(), EDA_SHAPE(), GetCornerRadius(), hitTest(), hitTest(), makeEffectiveShapes(), operator=(), rotate(), SetCornerRadius(), and SwapShape().

◆ m_customProperties

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

protectedinherited

◆ m_customPropsStorageCache

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

mutableprotectedinherited

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

Mirrors the per-object caches used by FOOTPRINT, SCH_SYMBOL and SCH_SHEET. Entries linger after a key is removed but are simply not enumerated.

Definition at line 622 of file eda_item.h.

Referenced by GetCustomPropertiesAsInspectables(), and RemoveCustomProperty().

◆ m_editState

int EDA_SHAPE::m_editState

protectedinherited

Definition at line 780 of file eda_shape.h.

Referenced by beginEdit(), calcEdit(), continueEdit(), Deserialize(), PCB_SHAPE::Deserialize(), EDA_SHAPE(), EDA_SHAPE(), EDA_SHAPE(), endEdit(), operator=(), recalcEllipseArcEndpoints(), setEditState(), and SwapShape().

◆ m_ellipse

ELLIPSE<int> EDA_SHAPE::m_ellipse

protectedinherited

◆ m_end

VECTOR2I EDA_SHAPE::m_end

protectedinherited

◆ m_endEnding

LINE_ENDING EDA_SHAPE::m_endEnding

protectedinherited

◆ m_endsSwapped

bool EDA_SHAPE::m_endsSwapped

protectedinherited

Definition at line 751 of file eda_shape.h.

Referenced by Deserialize(), PCB_SHAPE::Deserialize(), EDA_SHAPE(), EDA_SHAPE(), EDA_SHAPE(), EndsSwapped(), operator=(), SetArcAngleAndEnd(), SetArcGeometry(), SetEnd(), SetStart(), and SwapShape().

◆ m_fill

FILL_T EDA_SHAPE::m_fill

protectedinherited

Definition at line 757 of file eda_shape.h.

Referenced by Compare(), EDA_SHAPE(), EDA_SHAPE(), EDA_SHAPE(), GetFillMode(), GetFillModeProp(), operator=(), operator==(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_SHAPE::SetFilled(), setFilled(), SCH_SHAPE::setFilled(), SetFillMode(), Similarity(), SwapShape(), and SCH_SHAPE::ViewGetLayers().

◆ m_fillColor

COLOR4D EDA_SHAPE::m_fillColor

protectedinherited

Definition at line 758 of file eda_shape.h.

Referenced by Deserialize(), EDA_SHAPE(), EDA_SHAPE(), GetFillColor(), operator=(), operator==(), Serialize(), SetFillColor(), Similarity(), and SwapShape().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 608 of file eda_item.h.

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

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 206 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 614 of file eda_item.h.

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

◆ m_group

EDA_GROUP* EDA_ITEM::m_group

protectedinherited

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

Definition at line 610 of file eda_item.h.

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

◆ m_hasSolderMask

bool PCB_SHAPE::m_hasSolderMask

protected

Definition at line 382 of file pcb_shape.h.

Referenced by GetLayerSet(), HasSolderMask(), IsOnLayer(), operator==(), PCB_SHAPE(), PCB_SHAPE(), SetHasSolderMask(), Similarity(), swapData(), and ViewGetLayers().

◆ m_hatchingCache

std::unique_ptr<EDA_SHAPE_HATCH_CACHE_DATA> EDA_SHAPE::m_hatchingCache

mutableprotectedinherited

Definition at line 760 of file eda_shape.h.

Referenced by GetHatching(), GetHatchLines(), hatching(), hatchLines(), move(), and operator=().

◆ m_hatchingDirty

bool EDA_SHAPE::m_hatchingDirty

mutableprotectedinherited

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 204 of file view_item.h.

Referenced by IsBOARD_ITEM(), and VIEW_ITEM().

◆ m_isKnockout

bool BOARD_ITEM::m_isKnockout

protectedinherited

Definition at line 601 of file board_item.h.

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

◆ m_isLocked

bool BOARD_ITEM::m_isLocked

protectedinherited

Definition at line 602 of file board_item.h.

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

◆ m_isRollover

bool EDA_ITEM::m_isRollover

protectedinherited

Definition at line 613 of file eda_item.h.

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

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 203 of file view_item.h.

Referenced by IsSCH_ITEM(), and VIEW_ITEM().

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 600 of file board_item.h.

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

◆ m_libArcMid

VECTOR2I PCB_SHAPE::m_libArcMid

protected

Definition at line 390 of file pcb_shape.h.

Referenced by Flip(), GetLibraryArcMid(), OverrideLibCoords(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), swapData(), and syncLibCoords().

◆ m_libBezierC1

VECTOR2I PCB_SHAPE::m_libBezierC1

protected

Definition at line 392 of file pcb_shape.h.

Referenced by Flip(), GetLibraryBezierC1(), OverrideLibBezier(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), swapData(), and syncLibCoords().

◆ m_libBezierC2

VECTOR2I PCB_SHAPE::m_libBezierC2

protected

Definition at line 393 of file pcb_shape.h.

Referenced by Flip(), GetLibraryBezierC2(), OverrideLibBezier(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), swapData(), and syncLibCoords().

◆ m_libCornerRadius

int PCB_SHAPE::m_libCornerRadius

protected

Definition at line 388 of file pcb_shape.h.

Referenced by GetLibraryCornerRadius(), OverrideLibCornerRadius(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), swapData(), and syncLibCoords().

◆ m_libEllipseCenter

VECTOR2I PCB_SHAPE::m_libEllipseCenter

protected

Definition at line 397 of file pcb_shape.h.

Referenced by Flip(), GetLibraryEllipseCenter(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), SetLibraryEllipse(), swapData(), and syncLibCoords().

◆ m_libEllipseEndAngle

EDA_ANGLE PCB_SHAPE::m_libEllipseEndAngle

protected

Definition at line 402 of file pcb_shape.h.

Referenced by Flip(), GetLibraryEllipseEndAngle(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), SetLibraryEllipse(), swapData(), and syncLibCoords().

◆ m_libEllipseMajorRadius

int PCB_SHAPE::m_libEllipseMajorRadius

protected

Definition at line 398 of file pcb_shape.h.

Referenced by GetLibraryEllipseMajorRadius(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), SetLibraryEllipse(), swapData(), and syncLibCoords().

◆ m_libEllipseMinorRadius

int PCB_SHAPE::m_libEllipseMinorRadius

protected

Definition at line 399 of file pcb_shape.h.

Referenced by GetLibraryEllipseMinorRadius(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), SetLibraryEllipse(), swapData(), and syncLibCoords().

◆ m_libEllipseRotation

EDA_ANGLE PCB_SHAPE::m_libEllipseRotation

protected

Definition at line 400 of file pcb_shape.h.

Referenced by Flip(), GetLibraryEllipseRotation(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), SetLibraryEllipse(), swapData(), and syncLibCoords().

◆ m_libEllipseStartAngle

EDA_ANGLE PCB_SHAPE::m_libEllipseStartAngle

protected

Definition at line 401 of file pcb_shape.h.

Referenced by Flip(), GetLibraryEllipseStartAngle(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), SetLibraryEllipse(), swapData(), and syncLibCoords().

◆ m_libEnd

VECTOR2I PCB_SHAPE::m_libEnd

protected

Definition at line 386 of file pcb_shape.h.

Referenced by Flip(), GetLibraryEnd(), PCB_TEXTBOX::OnFootprintTransformed(), OverrideLibCoords(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), swapData(), syncLibCoords(), and PCB_TEXTBOX::syncLibCoords().

◆ m_libPoly

SHAPE_POLY_SET PCB_SHAPE::m_libPoly

protected

Definition at line 395 of file pcb_shape.h.

Referenced by Flip(), GetLibPoly(), GetLibraryPolyShape(), OverrideLibPoly(), rebakeFromTransform(), swapData(), and syncLibCoords().

◆ m_libShape

SHAPE_T PCB_SHAPE::m_libShape

protected

Definition at line 404 of file pcb_shape.h.

Referenced by Flip(), GetLibraryArcMid(), GetLibraryShape(), OverrideLibCoords(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), SetShape(), PCB_TEXTBOX::SetShape(), and swapData().

◆ m_libStart

VECTOR2I PCB_SHAPE::m_libStart

protected

Definition at line 385 of file pcb_shape.h.

Referenced by Flip(), GetLibraryStart(), PCB_TEXTBOX::OnFootprintTransformed(), OverrideLibCoords(), PCB_SHAPE(), PCB_SHAPE(), rebakeFromTransform(), swapData(), syncLibCoords(), and PCB_TEXTBOX::syncLibCoords().

◆ m_localRatsnestVisible

bool BOARD_CONNECTED_ITEM::m_localRatsnestVisible

privateinherited

Definition at line 250 of file board_connected_item.h.

Referenced by BOARD_CONNECTED_ITEM(), GetLocalRatsnestVisible(), and SetLocalRatsnestVisible().

◆ m_netHighlighted

bool EDA_ITEM::m_netHighlighted = false

protectedinherited

Definition at line 615 of file eda_item.h.

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

◆ m_netinfo

NETINFO_ITEM* BOARD_CONNECTED_ITEM::m_netinfo

protectedinherited

Store all information about the net that item belongs to.

Definition at line 243 of file board_connected_item.h.

Referenced by BOARD_CONNECTED_ITEM(), GetDisplayNetname(), GetEffectiveNetClass(), GetNet(), GetNetCode(), GetNetname(), GetShortNetname(), ZONE::InitDataFromSrcInCopyCtor(), PCB_SHAPE::operator==(), SetNet(), SetNetCode(), PCB_SHAPE::Similarity(), and PCB_SHAPE::swapData().

◆ m_owningIndex

BOARD_ITEM_INDEX* BOARD_ITEM::m_owningIndex = nullptr

mutableprotectedinherited

Board index that indexes this item, or nullptr.

Set only by the board's BOARD_ITEM_INDEX. Clones start detached.

Definition at line 608 of file board_item.h.

Referenced by BOARD_ITEM_INDEX::BindItem(), IsIndexedInBoard(), SetUuid(), BOARD_ITEM_INDEX::Unbind(), BOARD_ITEM_INDEX::UnbindItem(), and ~BOARD_ITEM().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Owner.

Definition at line 609 of file eda_item.h.

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

◆ m_poly

std::unique_ptr<SHAPE_POLY_SET> EDA_SHAPE::m_poly

mutableprotectedinherited

Definition at line 778 of file eda_shape.h.

Referenced by EDA_SHAPE(), GetPolyShape(), GetPolyShape(), operator=(), and SwapShape().

◆ m_proxyItem

bool EDA_SHAPE::m_proxyItem

protectedinherited

Definition at line 781 of file eda_shape.h.

Referenced by Deserialize(), PCB_SHAPE::Deserialize(), EDA_SHAPE(), EDA_SHAPE(), EDA_SHAPE(), IsProxyItem(), PCB_SHAPE::IsProxyItem(), operator=(), SetIsProxyItem(), and PCB_SHAPE::SetIsProxyItem().

◆ m_rectangleHeight

long long int EDA_SHAPE::m_rectangleHeight

protectedinherited

Definition at line 763 of file eda_shape.h.

Referenced by EDA_SHAPE(), EDA_SHAPE(), EDA_SHAPE(), operator=(), and SetRectangleHeight().

◆ m_rectangleWidth

long long int EDA_SHAPE::m_rectangleWidth

protectedinherited

Definition at line 764 of file eda_shape.h.

Referenced by EDA_SHAPE(), EDA_SHAPE(), EDA_SHAPE(), operator=(), and SetRectangleWidth().

◆ m_rolloverPos

VECTOR2I EDA_ITEM::m_rolloverPos

protectedinherited

Definition at line 612 of file eda_item.h.

Referenced by GetRolloverPos(), and SetIsRollover().

◆ m_shape

SHAPE_T EDA_SHAPE::m_shape

protectedinherited

Definition at line 752 of file eda_shape.h.

Referenced by buildShapeEllipse(), Compare(), EDA_SHAPE(), EDA_SHAPE(), PCB_SHAPE::Flip(), flip(), getBoundingBox(), getCenter(), PCB_SHAPE::GetConnectionPoints(), GetCornersInSequence(), PCB_TEXTBOX::GetCornersInSequence(), GetEndingTangents(), PCB_SHAPE::GetFocusPosition(), getFriendlyName(), GetLength(), GetLineEndingEndpoints(), getPosition(), GetRadius(), GetRectangleHeight(), GetRectangleWidth(), GetShape(), hitTest(), hitTest(), IsClockwiseArc(), IsClosed(), PCB_SHAPE::IsType(), SCH_RULE_AREA::MakeEffectiveShapes(), makeEffectiveShapes(), MakeEffectiveShapesForStroking(), makeShortenedBodyShapes(), move(), PCB_SHAPE::Normalize(), PCB_SHAPE::NormalizeForCompare(), PCB_TEXTBOX::OnFootprintTransformed(), operator=(), operator==(), PCB_SHAPE::rebakeFromTransform(), RebuildBezierToSegmentsPointsList(), recalcEllipseArcEndpoints(), rotate(), scale(), SetCenter(), SetCornerRadius(), SetRectangle(), SetRectangleHeight(), SetRectangleWidth(), SetShape(), SHAPE_T_asString(), ShapeGetMsgPanelInfo(), ShortenedBezierCurve(), ShowShape(), SwapShape(), PCB_SHAPE::syncLibCoords(), TransformShapeToPolygon(), TransformWithLineEndingsToPolygon(), and UpdateHatching().

◆ m_solderMaskMargin

std::optional<int> PCB_SHAPE::m_solderMaskMargin

protected

Definition at line 383 of file pcb_shape.h.

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

◆ m_start

VECTOR2I EDA_SHAPE::m_start

protectedinherited

◆ m_startEnding

LINE_ENDING EDA_SHAPE::m_startEnding

protectedinherited

◆ m_stroke

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

Definition at line 605 of file eda_item.h.

Referenced by EDA_ITEM(), EDA_ITEM(), EDA_ITEM(), IsType(), 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 247 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 599 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 205 of file view_item.h.

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

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

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

◆ AsEdaItem()

◆ BeginEdit()

◆ beginEdit()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ buildBezierToSegmentsPointsList()

◆ buildShapeEllipse()

◆ CalcArcAngles()

◆ CalcEdit()

◆ calcEdit()

◆ ClassOf()

◆ ClearBrightened()

◆ ClearCustomProperties()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Compare()

◆ computeArcBBox()

◆ ContinueEdit()

◆ continueEdit()

◆ CopyFrom()

◆ DeleteStructure()

◆ Deserialize() [1/3]

◆ Deserialize() [2/3]

◆ Deserialize() [3/3]

◆ DisambiguateItemDescription()

◆ Duplicate()

◆ EndEdit()

◆ endEdit()

◆ EndsSwapped()

◆ findParent()

◆ FitsEnabledLayers()

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

◆ GetCoverageArea()

◆ GetCustomProperties()

◆ GetCustomPropertiesAsInspectables()