#include <pcb_textbox.h>

Inheritance diagram for PCB_TEXTBOX:

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

Public Member Functions
	PCB_TEXTBOX (BOARD_ITEM *aParent, KICAD_T aType=PCB_TEXTBOX_T)

	~PCB_TEXTBOX ()

void	CopyFrom (const BOARD_ITEM *aOther) override

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

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.

void	Serialize (kiapi::board::types::BoardTextBox &aOutput) const

bool	Deserialize (const kiapi::board::types::BoardTextBox &aInput)

wxString	GetFriendlyName () const override

VECTOR2I	GetTopLeft () const override

VECTOR2I	GetBotRight () const override

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

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

void	SetShape (SHAPE_T aShape) override

VECTOR2I	GetMinSize () const
	Return the minimum height needed to contain the textbox's wrapped text content plus margins.

void	SetTop (int aVal) override

void	SetLeft (int aVal) override

void	SetRight (int aVal) override

void	SetBottom (int aVal) override

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

int	GetLegacyTextMargin () const

void	SetMarginLeft (int aLeft)

void	SetMarginTop (int aTop)

void	SetMarginRight (int aRight)

void	SetMarginBottom (int aBottom)

int	GetMarginLeft () const

int	GetMarginTop () const

int	GetMarginRight () const

int	GetMarginBottom () const

VECTOR2I	GetDrawPos () const override

VECTOR2I	GetDrawPos (bool aIsFlipped) const

EDA_ANGLE	GetTextAngle () const override

void	SetTextAngle (const EDA_ANGLE &aAngle) override

const EDA_ANGLE &	GetLibTextAngle () const
	Text angle in the parent footprint's lib frame, or absolute when not in a footprint.

void	SetLibTextAngle (const EDA_ANGLE &aAngle)

wxString	GetShownText (RESOLUTION_CONTEXT aContext, int aDepth=0) const override
	Return the string actually shown after processing of the base text.

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

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

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

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

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

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

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

VECTOR2I	GetTextSize () const override

void	SetTextSize (VECTOR2I aNewSize, bool aEnforceMinTextSize=true) override

int	GetTextThickness () const override

void	SetTextThickness (int aWidth) override
	The TextThickness is that set by the user.

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

wxString	GetClass () const override
	Return the class name.

void	TransformTextToPolySet (SHAPE_POLY_SET &aBuffer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc) const
	Function TransformTextToPolySet Convert the text to a polygonSet describing the actual character strokes (one per segment).

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

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.

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.

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

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

EDA_ITEM *	Clone () const override
	Tests whether the border is disabled, as configured by the stroke.

bool	IsBorderEnabled () const
	Disables the border, this is done by changing the stroke internally.

void	SetBorderEnabled (bool enabled)

void	SetBorderWidth (const int aSize)

int	GetBorderWidth () const

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_TEXTBOX &aOther) const

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

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)

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

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

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

bool	IsProxyItem () const override

void	SetIsProxyItem (bool aIsProxy=true) override

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

void	SetEnd (const VECTOR2I &aEnd) override

void	SetWidth (int aWidth) override

void	SetLibStrokeWidth (int aWidth)

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

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

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

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

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

double	Similarity (const EDA_SHAPE &aOther) const

bool	operator== (const PCB_SHAPE &aShape) const

bool	operator== (const EDA_SHAPE &aOther) const

void	SetHasSolderMask (bool aVal)

bool	HasSolderMask () const

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

std::optional< int >	GetLocalSolderMaskMargin () const

int	GetSolderMaskExpansion () const

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

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

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.

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 inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
	May be re-implemented for each derived class in order to handle all the types given by its member data.

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

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

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

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

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

virtual EMBEDDED_FILES *	GetEmbeddedFiles ()

bool	IsSCH_ITEM () const

bool	IsBOARD_ITEM () const

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

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

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

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

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

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

void	SwapShape (EDA_SHAPE *aImage)

wxString	ShowShape () const

wxString	SHAPE_T_asString () const

bool	IsAnyFill () const

bool	IsSolidFill () const

bool	IsHatchedFill () const

virtual bool	IsFilledForHitTesting () const

virtual void	SetFilled (bool aFlag)

void	SetFillMode (FILL_T aFill)

FILL_T	GetFillMode () const

void	SetFillModeProp (UI_FILL_MODE)

UI_FILL_MODE	GetFillModeProp () const

void	SetHatchingDirty ()

const SHAPE_POLY_SET &	GetHatching () const

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, bool aClosed, 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)

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

void	SetCenter (const VECTOR2I &aCenter)

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

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

int	GetRadius () const

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)

void	SetCornerRadius (int aRadius)

int	GetCornerRadius () const

bool	IsClockwiseArc () const

double	GetLength () const

int	GetRectangleHeight () const

int	GetRectangleWidth () const

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

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

void	Serialize (kiapi::common::types::Text &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::Text &aInput, const EDA_IU_SCALE &aScale)

virtual const wxString &	GetText () const
	Return the string associated with the text object.

bool	HasTextVars () const
	Indicates the ShownText has text var references which need to be processed.

const std::vector< TEXT_VAR_REF_KEY > &	GetTextVarReferences () const
	Return the set of `${...}` references extracted from the source text.

virtual void	SetText (const wxString &aText)

wxString	EvaluateText (const wxString &aText) const

int	GetTextThicknessProperty () const

void	SetAutoThickness (bool aAuto)

bool	GetAutoThickness () const

int	GetEffectiveTextPenWidth (int aDefaultPenWidth=0) const
	The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.

void	SetTextAngleDegrees (double aOrientation)

double	GetTextAngleDegrees () const

void	SetItalic (bool aItalic)
	Set the text to be italic - this will also update the font if needed.

void	SetItalicFlag (bool aItalic)
	Set only the italic flag, without changing the font.

bool	IsItalic () const

void	SetBold (bool aBold)
	Set the text to be bold - this will also update the font if needed.

void	SetBoldFlag (bool aBold)
	Set only the bold flag, without changing the font.

bool	IsBold () const

void	MigrateLegacyBoldStrokeWidth ()
	Migrate a pre-v11 bold stroke text so its stored thickness holds the base (non-bold) width.

virtual void	SetVisible (bool aVisible)

virtual bool	IsVisible () const

void	SetMirrored (bool isMirrored)

bool	IsMirrored () const

void	SetMultilineAllowed (bool aAllow)

bool	IsMultilineAllowed () const

void	SetHorizJustify (GR_TEXT_H_ALIGN_T aType)

GR_TEXT_H_ALIGN_T	GetHorizJustify () const

void	SetVertJustify (GR_TEXT_V_ALIGN_T aType)

GR_TEXT_V_ALIGN_T	GetVertJustify () const

void	SetKeepUpright (bool aKeepUpright)

bool	IsKeepUpright () const

void	FlipHJustify ()

void	SetAttributes (const EDA_TEXT &aSrc, bool aSetPosition=true)
	Set the text attributes from another instance.

void	SetAttributes (const TEXT_ATTRIBUTES &aTextAttrs)

void	SwapAttributes (EDA_TEXT &aTradingPartner)
	Swap the text attributes of the two involved instances.

void	SwapText (EDA_TEXT &aTradingPartner)

void	CopyText (const EDA_TEXT &aSrc)

const TEXT_ATTRIBUTES &	GetAttributes () const

bool	Replace (const EDA_SEARCH_DATA &aSearchData)
	Helper function used in search and replace dialog.

bool	IsDefaultFormatting () const

void	SetFont (KIFONT::FONT *aFont)

KIFONT::FONT *	GetFont () const

void	SetUnresolvedFontName (const wxString &aFontName)

wxString	GetUnresolvedFontName () const

bool	ResolveFont (const std::vector< wxString > *aEmbeddedFonts)

wxString	GetFontName () const

void	SetFontProp (const wxString &aFontName)

wxString	GetFontProp () const

void	SetLineSpacing (double aLineSpacing)

double	GetLineSpacing () const

virtual void	SetTextWidth (int aWidth)

virtual int	GetTextWidth () const

virtual void	SetTextHeight (int aHeight)

virtual int	GetTextHeight () const

void	SetTextColor (const COLOR4D &aColor)

COLOR4D	GetTextColor () const

virtual void	SetTextPos (const VECTOR2I &aPoint)

virtual VECTOR2I	GetTextPos () const

virtual void	SetTextX (int aX)

virtual void	SetTextY (int aY)

void	SetActiveUrl (const wxString &aUrl) const

virtual void	Offset (const VECTOR2I &aOffset)

void	Empty ()

void	Print (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor)
	Print this text object to the device context aDC.

std::shared_ptr< SHAPE_COMPOUND >	GetEffectiveTextShape (bool aTriangulate=true, const BOX2I &aBBox=BOX2I(), const EDA_ANGLE &aAngle=ANGLE_0) const
	build a list of segments (SHAPE_SEGMENT) to describe a text shape.

virtual bool	TextHitTest (const VECTOR2I &aPoint, int aAccuracy=0) const
	Test if aPoint is within the bounds of this object.

virtual bool	TextHitTest (const BOX2I &aRect, bool aContains, int aAccuracy=0) const
	Test if object bounding box is contained within or intersects aRect.

BOX2I	GetTextBox (const RENDER_SETTINGS *aSettings, int aLine=-1) const
	Useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....)

int	GetInterline (const RENDER_SETTINGS *aSettings) const
	Return the distance between two lines of text.

wxString	GetTextStyleName () const

void	GetLinePositions (const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPositions, int aLineCount) const
	Populate aPositions with the position of each line of a multiline text, according to the vertical justification and the rotation of the whole text.

double	Levenshtein (const EDA_TEXT &aOther) const
	Return the levenstein distance between two texts.

double	Similarity (const EDA_TEXT &aOther) const

virtual void	Format (OUTPUTFORMATTER *aFormatter, int aControlBits) const
	Output the object to aFormatter in s-expression form.

virtual EDA_ANGLE	GetDrawRotation () const

virtual KIFONT::FONT *	GetDrawFont (const RENDER_SETTINGS *aSettings) const

virtual void	ClearRenderCache ()

virtual void	ClearBoundingBoxCache ()

std::vector< std::unique_ptr< KIFONT::GLYPH > > *	GetRenderCache (const KIFONT::FONT *aFont, const wxString &forResolvedText, const VECTOR2I &aOffset={ 0, 0 }) const

void	SetupRenderCache (const wxString &aResolvedText, const KIFONT::FONT *aFont, const EDA_ANGLE &aAngle, const VECTOR2I &aOffset)

void	AddRenderCacheGlyph (const SHAPE_POLY_SET &aPoly)

int	Compare (const EDA_TEXT *aOther) const

bool	operator== (const EDA_TEXT &aRhs) const

bool	operator< (const EDA_TEXT &aRhs) const

bool	operator> (const EDA_TEXT &aRhs) const

virtual bool	HasHyperlink () const

wxString	GetHyperlink () const

void	SetHyperlink (wxString aLink)

void	RemoveHyperlink ()

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.

static GR_TEXT_H_ALIGN_T	MapHorizJustify (int aHorizJustify)

static GR_TEXT_V_ALIGN_T	MapVertJustify (int aVertJustify)

static bool	ValidateHyperlink (const wxString &aURL)
	Check if aURL is a valid hyperlink.

static bool	IsGotoPageHref (const wxString &aHref, wxString *aDestination=nullptr)
	Check if aHref is a valid internal hyperlink.

static wxString	GotoPageHref (const wxString &aDestination)
	Generate a href to a page in the current schematic.

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
EDA_ANGLE	getDrawRotation () const override

virtual void	swapData (BOARD_ITEM *aImage) override

void	syncLibCoords () override

const KIFONT::METRICS &	getFontMetrics () const override

bool	isMoving () const override

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)

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

virtual void	cacheShownText ()

void	printOneLineOfText (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor, const wxString &aText, const VECTOR2I &aPos)
	Print each line of this EDA_TEXT.

bool	containsURL () const

bool	isStrokeFont () const
	Return true if this text is (or, while a font resolution is still pending, is named as) a stroke font, as opposed to an outline font.

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

Protected Attributes
bool	m_borderEnabled
	Controls drawing the border (as defined by the stroke members)

bool	m_hasSolderMask

std::optional< int >	m_solderMaskMargin

VECTOR2I	m_libStart

VECTOR2I	m_libEnd

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 *	m_boardCacheOwner = nullptr

EDA_ITEM_FLAGS	m_flags

EDA_ITEM *	m_parent
	Owner.

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

VECTOR2I	m_rolloverPos

bool	m_isRollover

bool	m_forceVisible

bool	m_netHighlighted = false

std::map< wxString, wxString >	m_customProperties

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

bool	m_endsSwapped

SHAPE_T	m_shape

STROKE_PARAMS	m_stroke

LINE_ENDING	m_startEnding

LINE_ENDING	m_endEnding

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

wxString	m_hyperlink
	A hyperlink URL.

wxString	m_activeUrl

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

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

Private Attributes
int	m_marginLeft

int	m_marginTop

int	m_marginRight

int	m_marginBottom

EDA_ANGLE	m_libTextAngle

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.

wxString	m_text

wxString	m_shown_text

bool	m_shown_text_has_text_var_refs = false

std::vector< TEXT_VAR_REF_KEY >	m_text_var_refs

std::reference_wrapper< const EDA_IU_SCALE >	m_IuScale

std::unique_ptr< EDA_TEXT_RENDER_CACHE_DATA >	m_render_cache

std::map< int, BBOX_CACHE_ENTRY >	m_bbox_cache

std::mutex	m_bbox_cacheMutex

TEXT_ATTRIBUTES	m_attributes

wxString	m_unresolvedFontName

VECTOR2I	m_pos

bool	m_visible

Detailed Description

Definition at line 37 of file pcb_textbox.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum BOARD_ITEM::COMPARE_FLAGS : int

inherited

Enumerator
DRC
INSTANCE_TO_INSTANCE

Definition at line 556 of file board_item.h.

Constructor & Destructor Documentation

◆ PCB_TEXTBOX()

PCB_TEXTBOX::PCB_TEXTBOX	(	BOARD_ITEM *	aParent,
		KICAD_T	aType = PCB_TEXTBOX_T )

Definition at line 46 of file pcb_textbox.cpp.

References ANGLE_0, BOARD_ITEM::BOARD_ITEM(), EDA_TEXT::EDA_TEXT(), GetLegacyTextMargin(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_CENTER, m_borderEnabled, m_libTextAngle, m_marginBottom, m_marginLeft, m_marginRight, m_marginTop, PCB_SHAPE::PCB_SHAPE(), pcbIUScale, RECTANGLE, EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetMultilineAllowed(), and EDA_TEXT::SetVertJustify().

Referenced by Clone(), CopyFrom(), operator==(), operator==(), PCB_TABLECELL::PCB_TABLECELL(), Similarity(), and swapData().

◆ ~PCB_TEXTBOX()

PCB_TEXTBOX::~PCB_TEXTBOX ( )

Definition at line 64 of file pcb_textbox.cpp.

Member Function Documentation

◆ AddRenderCacheGlyph()

void EDA_TEXT::AddRenderCacheGlyph ( const SHAPE_POLY_SET & aPoly )

inherited

Definition at line 720 of file eda_text.cpp.

References KIFONT::OUTLINE_GLYPH::CacheTriangulation(), and m_render_cache.

◆ BeginEdit()

void PCB_SHAPE::BeginEdit ( const VECTOR2I & aStartPoint )

inlineinherited

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

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

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

◆ BoardLayerCount()

int BOARD_ITEM::BoardLayerCount ( ) const

virtualinherited

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

Definition at line 192 of file board_item.cpp.

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

◆ BoardLayerSet()

LSET BOARD_ITEM::BoardLayerSet ( ) const

virtualinherited

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

Definition at line 214 of file board_item.cpp.

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

Referenced by ALTIUM_PCB::ConvertPads6ToFootprintItemOnCopper().

◆ buildBezierToSegmentsPointsList()

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

protectedinherited

Definition at line 1215 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 1228 of file eda_shape.cpp.

References ELLIPSE_ARC, m_ellipse, and m_shape.

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

◆ cacheShownText()

void EDA_TEXT::cacheShownText ( )

protectedvirtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 587 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), ExtractTextVarReferences(), m_shown_text, m_shown_text_has_text_var_refs, m_text, m_text_var_refs, and UnescapeString().

Referenced by SCH_LABEL_BASE::cacheShownText(), CopyText(), EDA_TEXT(), Empty(), Replace(), SetText(), and SwapText().

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

inlineinherited

Definition at line 93 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 3124 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(), 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_TEXTBOX::ClassOf ( const EDA_ITEM * aItem )

inlinestatic

Definition at line 49 of file pcb_textbox.h.

References PCB_TEXTBOX_T, and EDA_ITEM::Type().

Referenced by TEXT_SEARCH_HANDLER::getResultCell().

◆ ClearBoundingBoxCache()

void EDA_TEXT::ClearBoundingBoxCache ( )

virtualinherited

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

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 178 of file eda_item.h.

References ClearFlags(), and GetEditFlags().

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 160 of file eda_item.h.

References EDA_ITEM_ALL_FLAGS, m_flags, and m_netHighlighted.

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

◆ ClearRenderCache()

void EDA_TEXT::ClearRenderCache ( )

virtualinherited

◆ 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_TEXTBOX::Clone ( ) const

overridevirtual

Tests whether the border is disabled, as configured by the stroke.

Reimplemented from PCB_SHAPE.

void PCB_TEXTBOX::CopyFrom ( const BOARD_ITEM * aOther )

overridevirtual

Reimplemented from PCB_SHAPE.

Definition at line 69 of file pcb_textbox.cpp.

References BOARD_ITEM::BOARD_ITEM(), PCB_TEXTBOX(), PCB_TEXTBOX_T, and EDA_ITEM::Type().

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

Definition at line 238 of file eda_text.cpp.

References cacheShownText(), EDA_TEXT(), and m_text.

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 303 of file board_item.cpp.

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

◆ Deserialize() [1/6]

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

inherited

Definition at line 461 of file eda_shape.cpp.

References Deserialize().

◆ Deserialize() [2/6]

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

inherited

Definition at line 364 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/6]

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

inherited

Definition at line 220 of file eda_text.cpp.

References Deserialize(), and text.

◆ Deserialize() [4/6]

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

inherited

Definition at line 201 of file eda_text.cpp.

References GetAttributes(), SetAttributes(), SetHyperlink(), SetText(), SetTextPos(), text, kiapi::common::UnpackTextAttributes(), and kiapi::common::UnpackVector2().

◆ Deserialize() [5/6]

bool PCB_TEXTBOX::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 PCB_SHAPE.

Definition at line 160 of file pcb_textbox.cpp.

References Deserialize().

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

◆ Deserialize() [6/6]

bool PCB_TEXTBOX::Deserialize ( const kiapi::board::types::BoardTextBox & aInput )

◆ DisambiguateItemDescription()

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

inlinevirtualinherited

Reimplemented in FOOTPRINT.

Definition at line 456 of file eda_item.h.

References GetItemDescription().

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ Duplicate()

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

virtualinherited

Create a copy of this BOARD_ITEM.

Parameters

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

Reimplemented in FOOTPRINT, PCB_TABLE, and ZONE.

Definition at line 352 of file board_item.cpp.

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

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

◆ Empty()

void EDA_TEXT::Empty ( )

inherited

Definition at line 580 of file eda_text.cpp.

References cacheShownText(), and m_text.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::LoadPart().

◆ EndEdit()

void PCB_SHAPE::EndEdit ( bool aClosed = true )

inlineinherited

Definition at line 99 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 3394 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 452 of file eda_shape.h.

References m_endsSwapped.

Referenced by BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ EvaluateText()

wxString EDA_TEXT::EvaluateText ( const wxString & aText ) const

inherited

Definition at line 619 of file eda_text.cpp.

References EXPRESSION_EVALUATOR::Evaluate().

◆ findParent()

EDA_ITEM * EDA_ITEM::findParent ( KICAD_T aType ) const

protectedinherited

Definition at line 137 of file eda_item.cpp.

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

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

◆ FitsEnabledLayers()

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

virtualinherited

Check if a board offering aEnabledLayers can hold this item.

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

Reimplemented in FOOTPRINT, and PCB_VIA.

Definition at line 37 of file board_item.cpp.

References GetLayerSet(), and IsLayerAgnostic().

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

◆ Flip()

void PCB_TEXTBOX::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 PCB_SHAPE.

Definition at line 676 of file pcb_textbox.cpp.

References ANGLE_180, PCB_SHAPE::Flip(), GetTextAngle(), EDA_TEXT::IsMirrored(), BOARD_ITEM::IsSideSpecific(), LEFT_RIGHT, m_libTextAngle, EDA_TEXT::SetMirrored(), and EDA_TEXT::SetTextAngle().

◆ flip()

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

protectedinherited

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

◆ FlipHJustify()

void EDA_TEXT::FlipHJustify ( )

inlineinherited

Definition at line 247 of file eda_text.h.

References GetHorizJustify(), GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, and SetHorizJustify().

Referenced by AdjustTextForSymbolOrientation(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorSpinStyle(), SCH_TEXT::MirrorVertically(), SCH_TEXT::Rotate90(), and SimulateRenderTransform().

◆ Format()

void EDA_TEXT::Format	(	OUTPUTFORMATTER *	aFormatter,
		int	aControlBits ) const

virtualinherited

Output the object to aFormatter in s-expression form.

Parameters

aFormatter	The OUTPUTFORMATTER object to write to.
aControlBits	The control bit definition for object specific formatting.

Exceptions

IO_ERROR on write error.

Definition at line 1063 of file eda_text.cpp.

const TEXT_ATTRIBUTES & EDA_TEXT::GetAttributes ( ) const

inlineinherited

Definition at line 270 of file eda_text.h.

References m_attributes.

Referenced by FEATURES_MANAGER::AddText(), BOARD_ADAPTER::addText(), PCB_IO_IPC2581::addText(), LIB_SYMBOL::Compare(), SCH_FIELD::compare(), MULTICHANNEL_TOOL::copyRuleAreaContents(), Deserialize(), PCB_TEXTBOX::Deserialize(), SCH_TEXTBOX::Deserialize(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DS_DRAW_ITEM_TEXT::GetApproxBBox(), GetEffectiveTextShape(), PCB_TEXT::GetKnockoutCache(), GetRenderCache(), SIM_MODEL::MigrateSimModel(), std::hash< EDA_TEXT >::operator()(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotText(), CLIPBOARD_IO::SaveSelection(), Serialize(), PCB_TEXTBOX::Serialize(), SCH_TEXTBOX::Serialize(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ GetAutoThickness()

bool EDA_TEXT::GetAutoThickness ( ) const

inlineinherited

Definition at line 170 of file eda_text.h.

References GetTextThickness().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), PCB_IO_KICAD_SEXPR::format(), GetTextThicknessProperty(), IsDefaultFormatting(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), and SetAutoThickness().

◆ 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 491 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(), 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 95 of file board_item.cpp.

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

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 86 of file board_item.cpp.

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

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

◆ GetBorderWidth()

int PCB_TEXTBOX::GetBorderWidth ( ) const

inline

Definition at line 205 of file pcb_textbox.h.

References EDA_SHAPE::m_stroke.

Referenced by PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC().

◆ GetBotRight()

VECTOR2I PCB_TEXTBOX::GetBotRight ( ) const

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 284 of file pcb_textbox.cpp.

References ANGLE_180, ANGLE_270, ANGLE_90, EDA_TEXT::GetDrawRotation(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetEndX(), EDA_SHAPE::GetEndY(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetStartX(), and EDA_SHAPE::GetStartY().

◆ GetBoundingBox()

const BOX2I PCB_TEXTBOX::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 PCB_SHAPE.

Definition at line 756 of file pcb_textbox.cpp.

References GetCorners(), PCB_SHAPE::GetWidth(), BOX2< Vec >::Inflate(), BOX2< Vec >::Merge(), and BOX2< Vec >::Normalize().

Referenced by BOOST_AUTO_TEST_CASE(), KIGFX::PCB_PAINTER::drawChartSymbols(), HitTest(), HitTest(), and BRDITEMS_PLOTTER::PlotChartSymbols().

◆ getBoundingBox()

const BOX2I EDA_SHAPE::getBoundingBox ( ) const

protectedinherited

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

inlineoverridevirtualinherited

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 78 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_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(), 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(), 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 1277 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(), getPosition(), hitTest(), hitTest(), makeEffectiveShapes(), SCH_SHAPE::Plot(), PLOTTER::ThickArc(), TransformShapeToPolygon(), and UpdateHatching().

◆ GetClass()

wxString PCB_TEXTBOX::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from PCB_SHAPE.

Definition at line 162 of file pcb_textbox.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

inherited

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 435 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 599 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_FIXTURE_TEST_CASE(), CONVERT_TOOL::CreateLines(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_IO_KICAD_SEXPR::format(), formatRect(), RECTANGLE_POINT_EDIT_BEHAVIOR::MakePoints(), RECTANGLE_POINT_EDIT_BEHAVIOR::MakePoints(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), processClosedShape(), OUTSET_ROUTINE::ProcessItem(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SegmentIntersectsBoard(), Serialize(), PCB_IO_IPC2581::shapeHash(), CREEPAGE_GRAPH::TransformEdgeToCreepShapes(), TransformShapeToPolygon(), UpdateHatching(), RECTANGLE_POINT_EDIT_BEHAVIOR::UpdatePoints(), and RECTANGLE_POINT_EDIT_BEHAVIOR::UpdatePoints().

◆ GetCorners()

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

overridevirtual

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

Unimplemented for other shapes.

Reimplemented from PCB_SHAPE.

Definition at line 232 of file pcb_textbox.cpp.

References GetCornersInSequence(), and EDA_TEXT::GetDrawRotation().

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

◆ GetCornersInSequence()

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

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 238 of file pcb_textbox.cpp.

References center, EDA_SHAPE::GetCornersInSequence(), EDA_ANGLE::IsZero(), left, EDA_SHAPE::m_end, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_ANGLE::Normalize(), RECTANGLE, right, RotatePoint(), and top().

Referenced by PCB_TABLE::DrawBorders(), GetCorners(), GetDrawPos(), PCB_TABLE::GetEffectiveShape(), PCB_TABLECELL::GetShownText(), and GetShownText().

◆ GetCustomProperties()

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

inlineinherited

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

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

Definition at line 242 of file eda_item.h.

References m_customProperties.

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

◆ GetCustomPropertiesAsInspectables()

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

inherited

Definition at line 200 of file eda_item.cpp.

References m_customProperties, m_dynamicCustomPropsCache, and TYPE_HASH.

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

◆ GetCustomProperty()

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

inherited

Returns: true if aKey is present and aValue was filled

Definition at line 188 of file eda_item.cpp.

References m_customProperties.

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

◆ GetDisplayNetname()

const wxString & BOARD_CONNECTED_ITEM::GetDisplayNetname ( ) const

inherited

Returns: the unescaped short netname.

Definition at line 192 of file board_connected_item.cpp.

References BOARD_ITEM::BOARD, 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().

◆ GetDrawFont()

KIFONT::FONT * EDA_TEXT::GetDrawFont ( const RENDER_SETTINGS * aSettings ) const

virtualinherited

◆ GetDrawPos() [1/2]

VECTOR2I PCB_TEXTBOX::GetDrawPos ( ) const

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 359 of file pcb_textbox.cpp.

References GetDrawPos().

Referenced by KIGFX::PCB_PAINTER::draw(), GetDrawPos(), and TransformTextToPolySet().

◆ GetDrawPos() [2/2]

VECTOR2I PCB_TEXTBOX::GetDrawPos ( bool aIsFlipped ) const

◆ GetDrawRotation()

virtual EDA_ANGLE EDA_TEXT::GetDrawRotation ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXT, and SCH_FIELD.

Definition at line 419 of file eda_text.h.

References GetTextAngle().

Referenced by FEATURES_MANAGER::AddText(), BOARD_ADAPTER::addText(), PCB_IO_IPC2581::addText(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_TABLE::DrawBorders(), PCB_IO_KICAD_SEXPR::formatRenderCache(), PCB_TEXTBOX::GetBotRight(), PCB_TEXTBOX::GetCorners(), PCB_TEXTBOX::GetDrawPos(), PCB_TEXTBOX::getDrawRotation(), PCB_TABLE::GetEffectiveShape(), GetEffectiveTextShape(), GetLinePositions(), PCB_TEXTBOX::GetMinSize(), SCH_TEXT::GetOffsetToMatchSCH_FIELD(), GetRenderCache(), PCB_TABLECELL::GetShownText(), PCB_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetTopLeft(), BRDITEMS_PLOTTER::PlotText(), printOneLineOfText(), PCB_TEXTBOX::SetBottom(), PCB_TEXTBOX::SetLeft(), PCB_TEXTBOX::SetRight(), PCB_TEXTBOX::SetTop(), TextHitTest(), and TextHitTest().

◆ getDrawRotation()

EDA_ANGLE PCB_TEXTBOX::getDrawRotation ( ) const

inlineoverrideprotectedvirtual

Reimplemented from EDA_SHAPE.

Definition at line 213 of file pcb_textbox.h.

References EDA_TEXT::GetDrawRotation().

◆ GetDynamicProperties()

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

overridevirtualinherited

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

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

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

Reimplemented from INSPECTABLE.

Reimplemented in FOOTPRINT, SCH_SHEET, and SCH_SYMBOL.

Definition at line 226 of file eda_item.cpp.

References GetCustomPropertiesAsInspectables().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

◆ GetEffectiveHoleShape()

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

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 405 of file board_item.cpp.

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

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

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

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

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

◆ GetEffectiveShape()

std::shared_ptr< SHAPE > PCB_TEXTBOX::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 PCB_SHAPE.

Definition at line 827 of file pcb_textbox.cpp.

References PCB_SHAPE::GetEffectiveShape(), EDA_TEXT::GetEffectiveTextShape(), PCB_SHAPE::GetStroke(), and PCB_SHAPE::GetWidth().

◆ GetEffectiveTextPenWidth()

int EDA_TEXT::GetEffectiveTextPenWidth ( int aDefaultPenWidth = 0 ) const

inherited

The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.

Definition at line 422 of file eda_text.cpp.

References BOLD_STROKE_MULTIPLIER, ClampTextPenSize(), GetPenSizeForBold(), GetPenSizeForNormal(), GetTextSize(), GetTextThickness(), GetTextWidth(), IsBold(), isStrokeFont(), and KiROUND().

Referenced by FEATURES_MANAGER::AddText(), BOARD_ADAPTER::addText(), PCB_IO_IPC2581::addText(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), LABEL_BBOX_FIXTURE::CheckTextBoundingBoxWidth(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_HIERLABEL::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_LABEL_BASE::GetBodyBoundingBox(), GetEffectiveTextShape(), PCB_TEXT::getKnockoutMargin(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_FIELD::GetPenWidth(), SCH_TEXT::GetPenWidth(), PCB_TABLECELL::GetShownText(), PCB_TEXTBOX::GetShownText(), SCH_TABLECELL::GetShownText(), SCH_TEXTBOX::GetShownText(), GetTextBox(), GetTextThicknessProperty(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotText(), printOneLineOfText(), PCB_TEXT::TextHitTest(), PCB_TEXT::TransformTextToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ GetEffectiveTextShape()

std::shared_ptr< SHAPE_COMPOUND > EDA_TEXT::GetEffectiveTextShape	(	bool	aTriangulate = true,
		const BOX2I &	aBBox = BOX2I(),
		const EDA_ANGLE &	aAngle = ANGLE_0 ) const

inherited

build a list of segments (SHAPE_SEGMENT) to describe a text shape.

Parameters

aTriangulate	true to build also the triangulation of each shape
aUseTextRotation	true to use the actual text draw rotation. false to build a list of shape for a not rotated text ("native" shapes).

Definition at line 1125 of file eda_text.cpp.

References SHAPE_SIMPLE::Append(), KIFONT::FONT::Draw(), KIGFX::GAL::DrawGlyphs(), FOR_CANVAS, GetAttributes(), BOX2< Vec >::GetCenter(), GetDrawFont(), GetDrawPos(), GetDrawRotation(), GetEffectiveTextPenWidth(), getFontMetrics(), GetRenderCache(), GetShownText(), GetTextSize(), BOX2< Vec >::GetWidth(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, KIFONT::FONT::IsOutline(), TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Size, and TEXT_ATTRIBUTES::m_Valign.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_DIMENSION_BASE::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), PCB_TEXTBOX::GetEffectiveShape(), SCH_SELECTION_TOOL::GuessSelectionCandidates(), and PCB_SELECTION_TOOL::hitTestDistance().

◆ GetEffectiveWidth()

virtual int EDA_SHAPE::GetEffectiveWidth ( ) const

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 164 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(), and TransformWithLineEndingsToPolygon().

◆ GetEllipse()

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

inlineinherited

References m_flags.

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

◆ GetFocusPosition()

const VECTOR2I PCB_SHAPE::GetFocusPosition ( ) const

overridevirtualinherited

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

virtual int EDA_SHAPE::GetHatchLineSpacing ( ) const

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

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

References GetEffectiveWidth().

Referenced by KIGFX::PCB_PAINTER::draw(), GetHatchLineSpacing(), and UpdateHatching().

◆ GetHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::GetHorizJustify ( ) const

inlineinherited

Definition at line 239 of file eda_text.h.

References m_attributes.

◆ GetHyperlink()

wxString EDA_TEXT::GetHyperlink ( ) const

inlineinherited

Definition at line 443 of file eda_text.h.

References m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), CLIPBOARD_IO::SaveSelection(), and Serialize().

◆ GetInterline()

int EDA_TEXT::GetInterline ( const RENDER_SETTINGS * aSettings ) const

inherited

Return the distance between two lines of text.

Calculates the distance (pitch) between two lines of text. This distance includes the interline distance plus room for characters like j, {, and [. It also used for single line text, to calculate the text bounding box.

Definition at line 730 of file eda_text.cpp.

References GetDrawFont(), getFontMetrics(), GetInterline(), GetLineSpacing(), GetTextHeight(), and KiROUND().

Referenced by BOOST_AUTO_TEST_CASE(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), GetInterline(), GetLinePositions(), and SCH_TEXT::Plot().

◆ GetItemDescription()

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

overridevirtual

Return a user-visible description string of this item.

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

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

Parameters

aLong indicates a long string is acceptable

Returns: The menu text string.

Reimplemented from PCB_SHAPE.

Definition at line 799 of file pcb_textbox.cpp.

References _, KIUI::EllipsizeMenuText(), FOR_GUI, BOARD_ITEM::GetLayerName(), GetShownText(), and EDA_TEXT::GetText().

◆ GetLayer()

PCB_LAYER_ID PCB_SHAPE::GetLayer ( ) const

inlineoverridevirtualinherited

Return the primary layer this item is on.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 68 of file pcb_shape.h.

References BOARD_ITEM::m_layer.

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

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

Returns: the layer name associated with this item.

Definition at line 225 of file board_item.cpp.

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

◆ GetLayerSet()

LSET PCB_SHAPE::GetLayerSet ( ) const

overridevirtualinherited

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

Reimplemented from BOARD_ITEM.

Definition at line 405 of file pcb_shape.cpp.

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

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

◆ GetLegacyTextMargin()

int PCB_TEXTBOX::GetLegacyTextMargin ( ) const

Definition at line 192 of file pcb_textbox.cpp.

References PCB_SHAPE::GetStroke(), GetTextSize(), PCB_SHAPE::GetWidth(), and KiROUND().

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), and PCB_TEXTBOX().

◆ GetLength()

double EDA_SHAPE::GetLength ( ) const

inherited

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

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

inlineinherited

◆ GetLibraryPolyShape()

SHAPE_POLY_SET PCB_SHAPE::GetLibraryPolyShape ( ) const

inherited

Definition at line 1255 of file pcb_shape.cpp.

References BOARD_ITEM::GetParent(), EDA_SHAPE::GetPolyShape(), TRANSFORM_TRS::InverseApply(), SHAPE_POLY_SET::IterateWithHoles(), m_libPoly, PCB_PAD_T, SHAPE_POLY_SET::SetVertex(), transformFp(), and EDA_ITEM::Type().

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

◆ GetLibraryShape()

SHAPE_T PCB_SHAPE::GetLibraryShape ( ) const

inlineinherited

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

inlineinherited

◆ GetLibTextAngle()

const EDA_ANGLE & PCB_TEXTBOX::GetLibTextAngle ( ) const

inline

Text angle in the parent footprint's lib frame, or absolute when not in a footprint.

Definition at line 122 of file pcb_textbox.h.

References m_libTextAngle.

◆ GetLineColor()

COLOR4D EDA_SHAPE::GetLineColor ( ) const

inlineinherited

Definition at line 172 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 4155 of file eda_shape.cpp.

References ARC, BEZIER, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CPoint(), 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(), MakeLineEndingEffectiveShapes(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), and TransformLineEndingsToPolygon().

◆ GetLineEndingsBoundingBox()

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

inherited

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

◆ GetLinePositions()

void EDA_TEXT::GetLinePositions	(	const RENDER_SETTINGS *	aSettings,
		std::vector< VECTOR2I > &	aPositions,
		int	aLineCount ) const

inherited

Populate aPositions with the position of each line of a multiline text, according to the vertical justification and the rotation of the whole text.

Parameters

aPositions	is the list to populate by the VECTOR2I positions.
aLineCount	is the number of lines (not recalculated here for efficiency reasons.

Definition at line 914 of file eda_text.cpp.

References GetDrawPos(), GetDrawRotation(), GetInterline(), GetVertJustify(), GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, GR_TEXT_V_ALIGN_TOP, RotatePoint(), and VECTOR2< T >::y.

Referenced by FEATURES_MANAGER::AddText(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotText(), and Print().

◆ GetLineSpacing()

double EDA_TEXT::GetLineSpacing ( ) const

inlineinherited

Definition at line 298 of file eda_text.h.

References m_attributes.

Referenced by BOOST_AUTO_TEST_CASE(), Format(), GetInterline(), GetTextBox(), FOOTPRINT::cmp_drawings::operator()(), and SCH_TEXTBOX::Serialize().

◆ GetLineStyle()

LINE_STYLE EDA_SHAPE::GetLineStyle ( ) const

inherited

Definition at line 3761 of file eda_shape.cpp.

References DEFAULT, m_stroke, and SOLID.

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

◆ GetLocalClearance() [1/2]

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

inlinevirtualinherited

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

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

Reimplemented in PAD, and ZONE.

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

Definition at line 1691 of file pcb_shape.cpp.

References BOARD_ITEM::GetMaxError().

Referenced by rebakeFromTransform().

◆ GetMenuImage()

BITMAPS PCB_TEXTBOX::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 PCB_SHAPE.

Definition at line 807 of file pcb_textbox.cpp.

References add_textbox.

◆ GetMinSize()

VECTOR2I PCB_TEXTBOX::GetMinSize ( ) const

Return the minimum height needed to contain the textbox's wrapped text content plus margins.

Width is unconstrained (returns 0) so text freely rewraps. The constrained axis depends on rotation: y-axis for 0/180, x-axis for 90/270.

Definition at line 198 of file pcb_textbox.cpp.

References std::abs(), ANGLE_270, ANGLE_90, EDA_TEXT::GetDrawRotation(), BOX2< Vec >::GetHeight(), GetMarginBottom(), GetMarginLeft(), GetMarginRight(), GetMarginTop(), EDA_TEXT::GetText(), GetTextAngle(), and EDA_TEXT::GetTextBox().

◆ GetMsgPanelInfo()

void PCB_TEXTBOX::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 PCB_SHAPE.

Definition at line 544 of file pcb_textbox.cpp.

References _, std::abs(), KIUI::EllipsizeStatusText(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_SHAPE::GetEnd(), EDA_TEXT::GetFont(), BOARD_ITEM::GetLayerName(), EDA_SHAPE::GetStart(), EDA_TEXT::GetText(), GetTextAngle(), EDA_TEXT::GetTextHeight(), GetTextThickness(), EDA_TEXT::GetTextWidth(), BOARD_ITEM::IsLocked(), EDA_TEXT::IsMirrored(), EDA_SHAPE::m_stroke, UNITS_PROVIDER::MessageTextFromValue(), and PCB_EDIT_FRAME_NAME.

◆ GetNet()

NETINFO_ITEM * BOARD_CONNECTED_ITEM::GetNet ( ) const

inlineinherited

Return #NET_INFO 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(), 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(), 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 156 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 129 of file board_connected_item.cpp.

References m_netinfo.

Referenced by CREEPAGE_GRAPH::AddNetElements(), TEARDROP_MANAGER::areItemsInSameZone(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), 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_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ZONE_FILLER::buildCopperItemClearances(), PCB_VIA_STITCH::buildPlacementCells(), KI_TEST::CheckFpZone(), DRC_TEST_PROVIDER_MATCHED_LENGTH::checkStubLengths(), TEARDROP_MANAGER::collidesWithOtherNets(), computeConstraint(), connectedItemFilter(), PCB_VIA_STACK::CreateFromItems(), GENCAD_EXPORTER::createRoutesSection(), TEARDROP_MANAGER::createTeardrop(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawVia(), BOARD::ExchangeFootprint(), extractDiffPairCoupledItems(), ZONE_FILLER::Fill(), MULTICHANNEL_TOOL::fixupNet(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), PCB_IO_KICAD_SEXPR::format(), CONNECTIVITY_DATA::GetConnectedItems(), ZONE::GetInteractingZones(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), GetNetnameMsg(), DIFF_PHASE_SKEW_TOOL::getNetPaths(), CONNECTIVITY_DATA::GetRatsnestForItems(), CONNECTIVITY_DATA::GetRatsnestForPad(), BOARD_INSPECTION_TOOL::highlightNet(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectDRCError(), CONNECTIVITY_DATA::IsConnectedOnLayer(), ZONE::IsIsland(), ItemHasDRCViolation(), ZONE_FILLER::knockoutThermalReliefs(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), MatchPendingStackExpansion(), AR_AUTOPLACER::nearestPad(), ROUTER_TOOL::NeighboringSegmentFilter(), DIALOG_DRC::OnDRCItemSelected(), PCB_TRACK::cmp_tracks::operator()(), ZONE_SETTINGS::operator<<(), ZONE_PAINTER::PCB_PAINTER(), BRDITEMS_PLOTTER::PlotShape(), process(), BOARD_EDITOR_CONTROL::RepairBoard(), BOARD_INSPECTION_TOOL::reportClearance(), PCB_VIA_STACK::reuseMembers(), DRC_TEST_PROVIDER_CONNECTION_WIDTH::Run(), ZONE::SameNet(), PCB_SELECTION_CONDITIONS::sameNetFunc(), CN_CONNECTIVITY_ALGO::searchConnections(), PCB_SELECTION_TOOL::selectNet(), PCB_SELECTION_TOOL::selectNetChain(), ZONE::Similarity(), EDIT_TOOL::SwapGateNets(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testKnockoutTextAgainstZone(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testTrackClearances(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DRC_TEST_PROVIDER_ZONE_CONNECTIONS::testZoneLayer(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testZonesToZones(), BOARD::TracksInNet(), PCB_SELECTION_TOOL::unrouteSelected(), PCB_CONTROL::UpdateMessagePanel(), PCB_TRACK::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEARDROPS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and BOARD_EDITOR_CONTROL::ZoneMerge().

◆ GetNetname()

wxString BOARD_CONNECTED_ITEM::GetNetname ( ) const

inherited

Returns: the full netname.

Definition at line 162 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_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(), 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 168 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 117 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 266 of file board_item.h.

References EDA_ITEM::m_parent.

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

◆ GetParentAsString()

wxString BOARD_ITEM::GetParentAsString ( ) const

inherited

For "parent" property.

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

Definition at line 451 of file board_item.cpp.

References EDA_ITEM::m_parent.

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ GetParentFootprint()

FOOTPRINT * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 112 of file board_item.cpp.

References EDA_ITEM::findParent(), and PCB_FOOTPRINT_T.

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

◆ GetParentGroup()

virtual EDA_GROUP * EDA_ITEM::GetParentGroup ( ) const

inlinevirtualinherited

Reimplemented in PCB_TABLECELL, and SCH_TABLECELL.

Definition at line 116 of file eda_item.h.

References m_group.

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

◆ GetParentGroupId()

KIID EDA_ITEM::GetParentGroupId ( ) const

inherited

Definition at line 232 of file eda_item.cpp.

References GetParentGroup(), group, and niluuid.

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

◆ GetPointCount()

int EDA_SHAPE::GetPointCount ( ) const

inherited

Returns: the number of corners of the polygonal shape.

Definition at line 3013 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 2968 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(), 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 2989 of file eda_shape.cpp.

References m_poly.

◆ GetPolyShape() [2/2]

const SHAPE_POLY_SET & EDA_SHAPE::GetPolyShape ( ) const

inherited

Definition at line 2997 of file eda_shape.cpp.

References m_poly.

◆ GetPosition()

VECTOR2I PCB_SHAPE::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 76 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 526 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 1366 of file eda_shape.cpp.

◆ GetShape()

SHAPE_T EDA_SHAPE::GetShape ( ) const

inlineinherited

Definition at line 175 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 4477 of file eda_shape.cpp.

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

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

◆ GetShortNetname()

const wxString & BOARD_CONNECTED_ITEM::GetShortNetname ( ) const

inherited

Returns: the short netname.

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

◆ GetShownText()

wxString PCB_TEXTBOX::GetShownText	(	RESOLUTION_CONTEXT	aContext,
		int	aDepth = 0 ) const

overridevirtual

Return the string actually shown after processing of the base text.

Parameters

aContext	controls some features of the expansion, such as whether or not field names are included, or whether or not escaped literal variable references should be prefixed with a '\'.
aDepth	is used to prevent infinite recursions and loops when expanding text variables.

Reimplemented from EDA_TEXT.

Definition at line 491 of file pcb_textbox.cpp.

References BOARD_ITEM::BOARD, FinalizeTextVarExpansion(), BOARD_ITEM::GetBoard(), GetCornersInSequence(), EDA_TEXT::GetDrawFont(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetEffectiveTextPenWidth(), BOARD_ITEM::GetLayerName(), GetMarginBottom(), GetMarginLeft(), GetMarginRight(), GetMarginTop(), BOARD_ITEM::GetParentFootprint(), EDA_TEXT::GetShownText(), GetTextAngle(), GetTextSize(), EDA_TEXT::HasTextVars(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), KIFONT::FONT::LinebreakText(), RAW_VALUE, resolver, FOOTPRINT::ResolveTextVar(), ResolveTextVars(), and text.

Referenced by EDIT_TOOL::copyToClipboardAsText(), KIGFX::PCB_PAINTER::draw(), GetItemDescription(), and TransformTextToPolySet().

◆ GetSolderMaskExpansion()

int PCB_SHAPE::GetSolderMaskExpansion ( ) const

inherited

◆ 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

Definition at line 276 of file eda_shape.h.

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

◆ GetText()

virtual const wxString & EDA_TEXT::GetText ( ) const

inlinevirtualinherited

Return the string associated with the text object.

Returns: a const wxString reference containing the string of the item.

Reimplemented in SCH_FIELD.

Definition at line 118 of file eda_text.h.

References m_text.

◆ GetTextAngle()

EDA_ANGLE PCB_TEXTBOX::GetTextAngle ( ) const

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 343 of file pcb_textbox.cpp.

References BOARD_ITEM::GetParentFootprint(), and m_libTextAngle.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::bakeTextBoxLib(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), Flip(), PCB_IO_KICAD_SEXPR::format(), GetMinSize(), GetMsgPanelInfo(), PCB_TABLECELL::GetShownText(), GetShownText(), hash_fp_item(), Mirror(), OnFootprintTransformed(), Rotate(), and SetTextAngle().

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const

inlineinherited

Definition at line 185 of file eda_text.h.

References m_attributes.

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_DIMENSION_BASE::GetTextAngleDegreesProp(), and SCH_TEXTBOX::Serialize().

◆ GetTextBox()

BOX2I EDA_TEXT::GetTextBox	(	const RENDER_SETTINGS *	aSettings,
		int	aLine = -1 ) const

inherited

Useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....)

Parameters

aLine The line of text to consider. Pass -1 for all lines.

Returns: the rect containing the line of text (i.e. the position and the size of one line) this rectangle is calculated for 0 orient text. If orientation is not 0 the rect must be rotated to match the physical area

Definition at line 737 of file eda_text.cpp.

References FOR_CANVAS, GetDrawFont(), GetDrawPos(), GetEffectiveTextPenWidth(), getFontMetrics(), BOX2< Vec >::GetHeight(), GetHorizJustify(), KIFONT::FONT::GetInterline(), GetLineSpacing(), GetShownText(), GetTextSize(), GetVertJustify(), BOX2< Vec >::GetWidth(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_INDETERMINATE, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_INDETERMINATE, GR_TEXT_V_ALIGN_TOP, IsBold(), IsItalic(), IsMirrored(), IsMultilineAllowed(), KIFONT::FONT::IsStroke(), ITALIC_TILT, KiROUND(), m_bbox_cache, m_bbox_cacheMutex, BOX2< Vec >::Normalize(), BOX2< Vec >::Offset(), BOX2< Vec >::SetOrigin(), BOX2< Vec >::SetSize(), BOX2< Vec >::SetX(), BOX2< Vec >::SetY(), KIFONT::FONT::StringBoundaryLimits(), text, wxStringSplit(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), LABEL_BBOX_FIXTURE::CheckLabelBodyBoundingBox(), LABEL_BBOX_FIXTURE::CheckTextBoundingBoxWidth(), SCH_GLOBALLABEL::CreateGraphicShape(), KIGFX::PCB_PAINTER::draw(), SCH_HIERLABEL::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), DS_DRAW_ITEM_TEXT::GetBoundingBox(), PCB_DIMENSION_BASE::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), PCB_TEXTBOX::GetMinSize(), SCH_TEXTBOX::GetMinSize(), SCH_TEXT::GetOffsetToMatchSCH_FIELD(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), SCH_TEXT::NormalizeJustification(), TextHitTest(), TextHitTest(), PCB_TEXT::TextHitTest(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and PCB_DIM_RADIAL::updateGeometry().

◆ GetTextColor()

COLOR4D EDA_TEXT::GetTextColor ( ) const

inlineinherited

◆ GetTextHeight()

virtual int EDA_TEXT::GetTextHeight ( ) const

inlinevirtualinherited

Definition at line 307 of file eda_text.h.

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

◆ GetTextPos()

virtual VECTOR2I EDA_TEXT::GetTextPos ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXT.

Definition at line 313 of file eda_text.h.

References m_pos.

Referenced by FEATURES_MANAGER::AddText(), SCH_LABEL_BASE::AutoplaceFields(), Compare(), SCH_FIELD::compare(), SCH_TEXT::compare(), SCH_SHEET_PIN::ConstrainOnEdge(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_GLOBALLABEL::doIsConnected(), SCH_HIERLABEL::doIsConnected(), SCH_LABEL::doIsConnected(), KIGFX::DS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_TEXT::Flip(), DS_DRAW_ITEM_TEXT::GetApproxBBox(), SCH_HIERLABEL::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_LABEL_BASE::GetBodyBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LABEL_BASE::GetConnectionPoints(), GetDrawPos(), SCH_LABEL_BASE::GetEndPoints(), SCH_SHEET_PIN::GetEndPoints(), SCH_FIELD::GetLibPosition(), DS_DRAW_ITEM_TEXT::GetPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetPosition(), PCB_TEXT::GetTextPos(), FIELDS_GRID_TABLE::GetValue(), PCB_DIMENSION_BASE::Mirror(), SCH_DIRECTIVE_LABEL::MirrorHorizontally(), SCH_FIELD::MirrorHorizontally(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), SCH_DIRECTIVE_LABEL::MirrorVertically(), SCH_FIELD::MirrorVertically(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), SCH_TEXT::NormalizeJustification(), PCB_TEXT::Offset(), std::hash< EDA_TEXT >::operator()(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotText(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), Serialize(), PCB_TEXT::SetLibTextPos(), SCH_LABEL_BASE::SetPosition(), SetTextPos(), SetTextX(), SetTextY(), FIELDS_GRID_TABLE::SetValue(), LIB_SYMBOL::SyncFieldsFromParent(), EASYEDA_PARSER_BASE::TransformTextToBaseline(), and SCH_LABEL_BASE::UpdateDanglingState().

◆ GetTextSize()

VECTOR2I PCB_TEXTBOX::GetTextSize ( ) const

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 581 of file pcb_textbox.cpp.

References std::abs(), BOARD_ITEM::GetParentFootprint(), TRANSFORM_TRS::GetScaleX(), TRANSFORM_TRS::GetScaleY(), EDA_TEXT::GetTextSize(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), KIGFX::PCB_PAINTER::draw(), GetLegacyTextMargin(), PCB_TABLECELL::GetShownText(), and GetShownText().

◆ GetTextStyleName()

wxString EDA_TEXT::GetTextStyleName ( ) const

inherited

Returns: a wxString with the style name( Normal, Italic, Bold, Bold+Italic).

Definition at line 1000 of file eda_text.cpp.

References _, IsBold(), and IsItalic().

Referenced by SCH_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

int PCB_TEXTBOX::GetTextThickness ( ) const

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 608 of file pcb_textbox.cpp.

References std::abs(), BOARD_ITEM::GetParentFootprint(), TRANSFORM_TRS::GetScaleX(), TRANSFORM_TRS::GetScaleY(), EDA_TEXT::GetTextThickness(), and KiROUND().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), PCB_TABLECELL::GetMsgPanelInfo(), and GetMsgPanelInfo().

◆ GetTextThicknessProperty()

int EDA_TEXT::GetTextThicknessProperty ( ) const

inlineinherited

Definition at line 161 of file eda_text.h.

References GetAutoThickness(), GetEffectiveTextPenWidth(), and GetTextThickness().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ GetTextVarReferences()

const std::vector< TEXT_VAR_REF_KEY > & EDA_TEXT::GetTextVarReferences ( ) const

inherited

Return the set of ${...} references extracted from the source text.

The result is cached lazily and invalidated on SetText/CopyText/Replace. Consumers (the reactive dependency tracker) may call this at high frequency on items that rarely change; the cache avoids repeat lexing.

Definition at line 613 of file eda_text.cpp.

References m_text_var_refs.

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

◆ GetTextWidth()

virtual int EDA_TEXT::GetTextWidth ( ) const

inlinevirtualinherited

Definition at line 304 of file eda_text.h.

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

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_TEXT::compare(), SCH_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), GetEffectiveTextPenWidth(), PCB_TEXT::getKnockoutMargin(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_HIERLABEL::GetSchematicTextOffset(), SCH_FIELD::GetSchTextSize(), SCH_TEXT::GetSchTextSize(), SCH_TEXTBOX::GetSchTextSize(), PCB_FIELDS_GRID_TABLE::GetValue(), hash_fp_item(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveText(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SetAutoThickness(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), DIALOG_FIELD_PROPERTIES::updateText(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ GetTopLeft()

VECTOR2I PCB_TEXTBOX::GetTopLeft ( ) const

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 269 of file pcb_textbox.cpp.

References ANGLE_180, ANGLE_270, ANGLE_90, EDA_TEXT::GetDrawRotation(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetEndX(), EDA_SHAPE::GetEndY(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetStartX(), and EDA_SHAPE::GetStartY().

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

◆ GetUnresolvedFontName()

wxString EDA_TEXT::GetUnresolvedFontName ( ) const

inlineinherited

Definition at line 289 of file eda_text.h.

References m_unresolvedFontName.

◆ GetVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::GetVertJustify ( ) const

inlineinherited

Definition at line 242 of file eda_text.h.

References m_attributes.

Referenced by AdjustTextForSymbolOrientation(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EE_GRAPHIC_TOOL::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), Format(), PCB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), SCH_FIELD::GetEffectiveVertJustify(), GetLinePositions(), SCH_FIELD::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), GetTextBox(), hash_fp_item(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), IsDefaultFormatting(), SCH_FIELD::IsVertJustifyFlipped(), PCB_TEXT::KeepUpright(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), SCH_TEXT::NormalizeJustification(), PCB_IO_EAGLE::orientFPText(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_FIELD::Plot(), positioningChanged(), positioningChanged(), printOneLineOfText(), processTextItem(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SCH_TEXTBOX::Serialize(), SimulateRenderTransform(), SCH_EDIT_TOOL::Swap(), and swapFieldPositionsWithMatching().

◆ GetWidth()

int PCB_SHAPE::GetWidth ( ) const

overridevirtualinherited

Reimplemented from EDA_SHAPE.

Definition at line 623 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(), EXPORTER_STEP::buildGraphic3DShape(), CONVERT_TOOL::CreateLines(), doConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), GetBoardItemWidth(), PCB_TEXTBOX::GetBoundingBox(), FOOTPRINT::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()(), 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 133 of file board_item.h.

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

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

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 139 of file board_item.h.

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

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

◆ GotoPageHref()

wxString EDA_TEXT::GotoPageHref ( const wxString & aDestination )

staticinherited

Generate a href to a page in the current schematic.

Parameters

aDestination Destination sheet's page number.

Returns: A hyperlink href string that goes to the specified page.

See also: STROKE_PARAMS

Reimplemented from BOARD_ITEM.

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

inlineinherited

Definition at line 336 of file pcb_shape.h.

References m_hasSolderMask.

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

◆ HasTextVars()

bool EDA_TEXT::HasTextVars ( ) const

inlineinherited

Indicates the ShownText has text var references which need to be processed.

Definition at line 139 of file eda_text.h.

References m_shown_text_has_text_var_refs.

Referenced by BACK_ANNOTATE::applyChangelist(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_LABEL_BASE::cacheShownText(), KIGFX::SCH_PAINTER::draw(), PCB_FIELD::GetShownText(), PCB_TABLECELL::GetShownText(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TABLECELL::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_LABEL_BASE::HasCachedDriverName(), SCH_GLOBALLABEL::ResolveTextVar(), and SCH_LABEL_BASE::SCH_LABEL_BASE().

◆ hatching()

SHAPE_POLY_SET & EDA_SHAPE::hatching ( ) const

protectedinherited

Definition at line 753 of file eda_shape.cpp.

References m_hatchingCache.

Referenced by UpdateHatching().

◆ hatchLines()

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

protectedinherited

Definition at line 762 of file eda_shape.cpp.

References m_hatchingCache.

Referenced by UpdateHatching().

◆ HitTest() [1/3]

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

overridevirtual

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

Definition at line 780 of file pcb_textbox.cpp.

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

◆ HitTest() [2/3]

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

overridevirtual

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

Definition at line 793 of file pcb_textbox.cpp.

References PCB_SHAPE::HitTest().

◆ HitTest() [3/3]

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

overridevirtual

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

Definition at line 770 of file pcb_textbox.cpp.

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

◆ hitTest() [1/3]

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

protectedinherited

Definition at line 1853 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 2075 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 1655 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

bool EDA_SHAPE::IsClosed ( ) const

inherited

Definition at line 667 of file eda_shape.cpp.

References ARC, BEZIER, CIRCLE, ELLIPSE, ELLIPSE_ARC, GetPolyShape(), SHAPE_LINE_CHAIN::IsClosed(), m_bezierPoints, m_shape, SHAPE_POLY_SET::Outline(), POLY, RECTANGLE, SEGMENT, SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by SCH_POINT_EDITOR::addCorner(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), hitTest(), PCB_SELECTION_TOOL::isExpandableGraphicShape(), CONVERT_TOOL::makePolysFromClosedGraphics(), CONVERT_TOOL::makePolysFromOpenGraphics(), and SCH_SHAPE::Plot().

◆ IsConnected()

bool PCB_SHAPE::IsConnected ( ) const

overridevirtualinherited

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

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

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

inherited

Definition at line 1056 of file eda_text.cpp.

References GetAutoThickness(), GetFontName(), GetHorizJustify(), GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, IsBold(), IsItalic(), IsMirrored(), and IsMultilineAllowed().

Referenced by SCH_IO_KICAD_SEXPR::saveField().

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

◆ IsGotoPageHref()

bool EDA_TEXT::IsGotoPageHref	(	const wxString &	aHref,
		wxString *	aDestination = nullptr )

staticinherited

Check if aHref is a valid internal hyperlink.

Parameters

aHref	String to validate
aDestination	[optional] pointer to populate with the destination page

Returns: true if aHref is a valid internal hyperlink. Does not check if the destination page actually exists.

Definition at line 1303 of file eda_text.cpp.

Referenced by PDF_PLOTTER::endPlotEmitResources(), SCH_NAVIGATE_TOOL::HypertextCommand(), and ValidateHyperlink().

◆ IsGroupableType()

bool BOARD_ITEM::IsGroupableType ( ) const

inherited

◆ IsHatchedFill()

bool EDA_SHAPE::IsHatchedFill ( ) const

inlineinherited

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Reimplemented in PCB_BARCODE.

Definition at line 413 of file board_item.h.

References m_isKnockout.

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

◆ IsLayerAgnostic()

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_CONSTRAINT, and PCB_GROUP.

Definition at line 307 of file board_item.h.

Referenced by FitsEnabledLayers().

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

References m_attributes.

Referenced by FEATURES_MANAGER::AddText(), GetTextBox(), IsDefaultFormatting(), BRDITEMS_PLOTTER::PlotText(), Print(), and SCH_TEXTBOX::Serialize().

◆ IsNetHighlighted()

bool EDA_ITEM::IsNetHighlighted ( ) const

inherited

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

Definition at line 125 of file eda_item.cpp.

References m_netHighlighted.

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

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References IS_NEW, and m_flags.

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

◆ IsOnCopperLayer()

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

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::CheckNetTies(), DRC_ENGINE::EvalRules(), PCB_SHAPE::GetItemDescription(), PCB_SHAPE::GetMsgPanelInfo(), PCB_SHAPE::IsConnected(), isCopper(), PCB_SELECTION_TOOL::isExpandableGraphicShape(), ZONE_PAINTER::PCB_PAINTER(), 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

overridevirtualinherited

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

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

Parameters

aLayer The layer to test for.

Returns: true if on given layer, else false.

Reimplemented from BOARD_ITEM.

Definition at line 387 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 3006 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(), PCB_IO_KICAD_SEXPR::format(), idf_append_shape(), BRDITEMS_PLOTTER::PlotShape(), TransformShapeToPolygon(), and TransformWithLineEndingsToPolygon().

◆ IsProxyItem()

bool PCB_SHAPE::IsProxyItem ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_SHAPE.

Definition at line 153 of file pcb_shape.h.

References EDA_SHAPE::m_proxyItem.

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

◆ IsReplaceable()

virtual bool EDA_ITEM::IsReplaceable ( ) const

inlinevirtualinherited

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

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

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

Definition at line 520 of file eda_item.h.

Referenced by Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

References m_isRollover.

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

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 97 of file view_item.h.

References m_isSCH_ITEM.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 134 of file eda_item.h.

References m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 206 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and m_flags.

◆ IsSideSpecific()

bool BOARD_ITEM::IsSideSpecific ( ) const

inherited

Definition at line 235 of file board_item.cpp.

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

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

◆ IsSolidFill()

bool EDA_SHAPE::IsSolidFill ( ) const

inlineinherited

◆ isStrokeFont()

bool EDA_TEXT::isStrokeFont ( ) const

protectedinherited

Return true if this text is (or, while a font resolution is still pending, is named as) a stroke font, as opposed to an outline font.

Definition at line 271 of file eda_text.cpp.

References GetFont(), KIFONT::FONT::IsStroke(), and m_unresolvedFontName.

Referenced by GetEffectiveTextPenWidth(), MigrateLegacyBoldStrokeWidth(), SetBold(), and SetItalic().

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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

Parameters

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

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

Reimplemented in PCB_VIA.

Definition at line 224 of file board_item.h.

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

◆ IsType()

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

inlineoverridevirtual

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

Definition at line 54 of file pcb_textbox.h.

References EDA_ITEM::IsType(), and PCB_LOCATE_TEXT_T.

◆ IsVisible()

virtual bool EDA_TEXT::IsVisible ( ) const

inlinevirtualinherited

Definition at line 226 of file eda_text.h.

References m_visible.

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

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

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

◆ Levenshtein()

double EDA_TEXT::Levenshtein ( const EDA_TEXT & aOther ) const

inherited

Return the levenstein distance between two texts.

Return a value of 0.0 - 1.0 where 1.0 is a perfect match.

Definition at line 1242 of file eda_text.cpp.

References distance(), EDA_TEXT(), and GetText().

Referenced by Similarity().

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

Definition at line 2345 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 569 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 2299 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(), 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 2694 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 2573 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 2597 of file eda_shape.cpp.

References ARC, BEZIER, CalcArcAngles(), SHAPE_POLY_SET::COutline(), end, GetEffectiveWidth(), GetEnd(), 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().

◆ MapHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::MapHorizJustify ( int aHorizJustify )

staticinherited

Definition at line 70 of file eda_text.cpp.

References GR_TEXT_H_ALIGN_LEFT, and GR_TEXT_H_ALIGN_RIGHT.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_FIELD::SetEffectiveHorizJustify(), FIELDS_GRID_TABLE::SetValue(), DIALOG_FIELD_PROPERTIES::UpdateField(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ MapVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::MapVertJustify ( int aVertJustify )

staticinherited

Definition at line 84 of file eda_text.cpp.

References GR_TEXT_V_ALIGN_BOTTOM, and GR_TEXT_V_ALIGN_TOP.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_FIELD::SetEffectiveVertJustify(), FIELDS_GRID_TABLE::SetValue(), DIALOG_FIELD_PROPERTIES::UpdateField(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ Matches() [1/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 318 of file eda_item.cpp.

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

◆ Matches() [2/2]

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

overridevirtual

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 from EDA_ITEM.

Definition at line 538 of file pcb_textbox.cpp.

References EDA_TEXT::GetText(), EDA_ITEM::Matches(), and UnescapeString().

◆ MigrateLegacyBoldStrokeWidth()

void EDA_TEXT::MigrateLegacyBoldStrokeWidth ( )

inherited

Migrate a pre-v11 bold stroke text so its stored thickness holds the base (non-bold) width.

Older files baked the bolded pen size into the stroke width; Bold is now a render-time multiplier, so divide it back out. No-op for auto width, non-bold text, or outline fonts (where thickness is not the weight mechanism).

Definition at line 327 of file eda_text.cpp.

References BOLD_STROKE_MULTIPLIER, GetTextThickness(), IsBold(), isStrokeFont(), KiROUND(), and SetTextThickness().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), BOOST_AUTO_TEST_CASE(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT().

◆ Mirror()

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

overridevirtual

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

Parameters

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

Reimplemented from PCB_SHAPE.

Definition at line 661 of file pcb_textbox.cpp.

References ANGLE_180, GetTextAngle(), LEFT_RIGHT, m_libTextAngle, PCB_SHAPE::Mirror(), and EDA_TEXT::SetTextAngle().

◆ Move()

void PCB_TEXTBOX::Move ( const VECTOR2I & aMoveVector )

overridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from PCB_SHAPE.

Definition at line 574 of file pcb_textbox.cpp.

References PCB_SHAPE::Move(), and EDA_TEXT::Offset().

◆ move()

void EDA_SHAPE::move ( const VECTOR2I & aMoveVector )

protectedinherited

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

overridevirtualinherited

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

Reimplemented from BOARD_ITEM.

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

overridevirtualinherited

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

◆ Offset()

void EDA_TEXT::Offset ( const VECTOR2I & aOffset )

virtualinherited

◆ OnFootprintRescaled()

void PCB_TEXTBOX::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 PCB_SHAPE.

Definition at line 749 of file pcb_textbox.cpp.

References OnFootprintTransformed().

◆ OnFootprintTransformed()

void PCB_TEXTBOX::OnFootprintTransformed ( )

overridevirtual

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

Scaling uses OnFootprintRescaled.

Reimplemented from PCB_SHAPE.

Definition at line 693 of file pcb_textbox.cpp.

References std::abs(), TRANSFORM_TRS::Apply(), EDA_TEXT::ClearBoundingBoxCache(), EDA_TEXT::ClearRenderCache(), PCB_SHAPE::GetLibraryShape(), BOARD_ITEM::GetParentFootprint(), TRANSFORM_TRS::GetScaleX(), TRANSFORM_TRS::GetScaleY(), GetTextAngle(), KiROUND(), PCB_SHAPE::m_libEnd, PCB_SHAPE::m_libStart, EDA_SHAPE::m_shape, PCB_SHAPE::OnFootprintTransformed(), RECTANGLE, EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), EDA_TEXT::SetTextAngle(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::bakeTextBoxLib(), and OnFootprintRescaled().

◆ operator<() [1/2]

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

bool EDA_TEXT::operator< ( const EDA_TEXT & aRhs ) const

inlineinherited

Definition at line 439 of file eda_text.h.

References Compare(), and EDA_TEXT().

◆ operator==() [1/5]

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

inherited

◆ operator==() [2/5]

bool EDA_TEXT::operator== ( const EDA_TEXT & aRhs ) const

inlineinherited

Definition at line 438 of file eda_text.h.

References Compare(), and EDA_TEXT().

Referenced by SCH_FIELD::HasSameContent(), PCB_DIMENSION_BASE::operator==(), PCB_FIELD::operator==(), PCB_TEXT::operator==(), PCB_TEXTBOX::operator==(), SCH_FIELD::operator==(), SCH_TEXT::operator==(), and SCH_TEXTBOX::operator==().

◆ operator==() [3/5]

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

inherited

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

◆ operator==() [4/5]

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

overridevirtual

Reimplemented from PCB_SHAPE.

Definition at line 965 of file pcb_textbox.cpp.

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

◆ operator==() [5/5]

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

Definition at line 976 of file pcb_textbox.cpp.

References m_borderEnabled, EDA_TEXT::operator==(), and PCB_TEXTBOX().

Referenced by PCB_TABLECELL::operator==().

◆ operator>()

bool EDA_TEXT::operator> ( const EDA_TEXT & aRhs ) const

inlineinherited

Definition at line 440 of file eda_text.h.

References Compare(), and EDA_TEXT().

◆ OverrideLibBezier()

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

inlineinherited

Definition at line 274 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 ) )

inlineinherited

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

◆ OverrideLibPoly()

void PCB_SHAPE::OverrideLibPoly ( const SHAPE_POLY_SET & aPoly )

inlineinherited

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

◆ Print()

void EDA_TEXT::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		const COLOR4D &	aColor )

inherited

Print this text object to the device context aDC.

Parameters

aDC	the current Device Context.
aOffset	draw offset (usually (0,0)).
aColor	text color.

Definition at line 892 of file eda_text.cpp.

References FOR_CANVAS, GetDrawPos(), GetLinePositions(), GetShownText(), IsMultilineAllowed(), printOneLineOfText(), and wxStringSplit().

Referenced by DS_DRAW_ITEM_TEXT::PrintWsItem().

◆ printOneLineOfText()

void EDA_TEXT::printOneLineOfText	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		const COLOR4D &	aColor,
		const wxString &	aText,
		const VECTOR2I &	aPos )

protectedinherited

Print each line of this EDA_TEXT.

Parameters

aOffset	draw offset (usually (0,0)).
aColor	text color.
aText	the single line of text to draw.
aPos	the position of this line ).

Referenced by KI_TEST::addBezier(), 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 1238 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 287 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_dynamicCustomPropsCache.

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

◆ RemoveHyperlink()

void EDA_TEXT::RemoveHyperlink ( )

inlineinherited

Definition at line 445 of file eda_text.h.

References m_hyperlink.

◆ 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/3]

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

inlinevirtualinherited

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

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

Parameters

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

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

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

Definition at line 509 of file eda_item.h.

◆ Replace() [2/3]

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

◆ Replace() [3/3]

bool EDA_TEXT::Replace ( const EDA_SEARCH_DATA & aSearchData )

inherited

Helper function used in search and replace dialog.

Perform a text replace using the find and replace criteria in aSearchData.

Parameters

aSearchData A reference to a EDA_SEARCH_DATA object containing the search and replace criteria.

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

Definition at line 445 of file eda_text.cpp.

References cacheShownText(), ClearBoundingBoxCache(), ClearRenderCache(), m_text, and EDA_ITEM::Replace().

Referenced by SCH_FIELD::Replace(), SCH_LABEL_BASE::Replace(), SCH_SHEET_PIN::Replace(), SCH_TEXT::Replace(), and SCH_TEXTBOX::Replace().

◆ ResetUuid()

void BOARD_ITEM::ResetUuid ( )

inlineinherited

Definition at line 280 of file board_item.h.

References SetUuid().

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

◆ ResetUuidDirect()

void BOARD_ITEM::ResetUuidDirect ( )

inlineinherited

Definition at line 277 of file board_item.h.

References SetUuidDirect().

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

◆ ResolveFont()

bool EDA_TEXT::ResolveFont ( const std::vector< wxString > * aEmbeddedFonts )

inherited

Definition at line 466 of file eda_text.cpp.

References ClearBoundingBoxCache(), KIFONT::FONT::GetFont(), IsBold(), IsItalic(), m_attributes, m_render_cache, and m_unresolvedFontName.

Referenced by BOOST_AUTO_TEST_CASE().

◆ Rotate()

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

overridevirtual

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from PCB_SHAPE.

Definition at line 636 of file pcb_textbox.cpp.

References delta, BOARD_ITEM::GetParentFootprint(), GetTextAngle(), KiROUND(), EDA_SHAPE::m_end, m_libTextAngle, EDA_SHAPE::m_start, PCB_SHAPE::Normalize(), RotatePoint(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), EDA_TEXT::SetTextAngle(), syncLibCoords(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SetTextAngle().

◆ rotate()

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

protectedinherited

Definition at line 1077 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 264 of file board_item.h.

References BOARD_ITEM().

Referenced by BOARD::CacheChildrenById(), BOARD::CacheItemSubtreeById(), BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), CollectConstraintScopeIds(), 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(), ALLEGRO::BOARD_BUILDER::stampIds(), BOARD::UncacheChildrenById(), BOARD::UncacheItemSubtreeById(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), PCB_SELECTION_TOOL::unrouteSegment(), PCB_SELECTION_TOOL::unrouteSelected(), KIGFX::PCB_VIEW::Update(), and PCB_SELECTION::updateDrawList().

◆ Scale()

void PCB_SHAPE::Scale ( double aScale )

inherited

Definition at line 716 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 1013 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/6]

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

inherited

Definition at line 350 of file eda_shape.cpp.

References Serialize().

◆ Serialize() [2/6]

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

inherited

◆ Serialize() [3/6]

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

inherited

Definition at line 187 of file eda_text.cpp.

References Serialize(), and text.

◆ Serialize() [4/6]

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

inherited

Definition at line 171 of file eda_text.cpp.

References GetAttributes(), GetHyperlink(), GetText(), GetTextPos(), kiapi::common::PackTextAttributes(), kiapi::common::PackVector2(), and text.

◆ Serialize() [5/6]

void PCB_TEXTBOX::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 PCB_SHAPE.

Definition at line 109 of file pcb_textbox.cpp.

References Serialize().

Referenced by PCB_TABLECELL::Serialize(), and Serialize().

◆ Serialize() [6/6]

void PCB_TEXTBOX::Serialize ( kiapi::board::types::BoardTextBox & aOutput ) const

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

◆ SetActiveUrl()

void EDA_TEXT::SetActiveUrl ( const wxString & aUrl ) const

inlineinherited

Definition at line 318 of file eda_text.h.

References m_activeUrl.

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

◆ SetArcAngle()

void PCB_SHAPE::SetArcAngle ( const EDA_ANGLE & aAngle )

inlineoverridevirtualinherited

Reimplemented from EDA_SHAPE.

Definition at line 113 of file pcb_shape.h.

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

◆ SetArcAngleAndEnd()

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

inlineinherited

Definition at line 107 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 )

inherited

◆ SetAttributes() [1/2]

void EDA_TEXT::SetAttributes	(	const EDA_TEXT &	aSrc,
		bool	aSetPosition = true )

inherited

Set the text attributes from another instance.

Definition at line 389 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), EDA_TEXT(), m_attributes, and m_pos.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), MULTICHANNEL_TOOL::copyRuleAreaContents(), Deserialize(), PCB_TEXTBOX::Deserialize(), SCH_TEXTBOX::Deserialize(), SCH_FIELD::ImportValues(), SCH_IO_EAGLE::loadLibrary(), SCH_IO_EAGLE::loadSymbol(), SIM_MODEL::MigrateSimModel(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_CHANGE_SYMBOLS::processSymbols(), processTextItem(), CLIPBOARD_IO::SaveSelection(), and LIB_SYMBOL::SyncFieldsFromParent().

◆ SetAttributes() [2/2]

void EDA_TEXT::SetAttributes ( const TEXT_ATTRIBUTES & aTextAttrs )

inlineinherited

Definition at line 269 of file eda_text.h.

References m_attributes.

◆ SetAutoThickness()

void EDA_TEXT::SetAutoThickness ( bool aAuto )

inherited

Definition at line 253 of file eda_text.cpp.

References GetAutoThickness(), GetPenSizeForNormal(), GetTextWidth(), and SetTextThickness().

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

◆ SetBezierC1()

void PCB_SHAPE::SetBezierC1 ( const VECTOR2I & aPt )

overridevirtualinherited

Reimplemented from EDA_SHAPE.

Definition at line 1281 of file pcb_shape.cpp.

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

Referenced by KI_TEST::addBezier(), 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 )

overridevirtualinherited

Reimplemented from EDA_SHAPE.

Definition at line 1288 of file pcb_shape.cpp.

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

Referenced by KI_TEST::addBezier(), 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().

◆ SetBold()

void EDA_TEXT::SetBold ( bool aBold )

inherited

Set the text to be bold - this will also update the font if needed.

This is the properties system interface.

Definition at line 305 of file eda_text.cpp.

References GetFont(), KIFONT::FONT::GetFont(), IsItalic(), isStrokeFont(), m_attributes, SetBoldFlag(), and SetFont().

Referenced by SCH_IO_ALTIUM::AddTextBox(), ORCAD_CONVERTER::applyFont(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_IO_EAGLE::loadTextAttributes(), SCH_IO_ALTIUM::ParseLabel(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), SCH_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetBoldFlag()

void EDA_TEXT::SetBoldFlag ( bool aBold )

inherited

Set only the bold flag, without changing the font.

Used when bulk-changing text attributes (e.g. from a dialog or import).

Definition at line 319 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_KICAD_LEGACY::loadSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SetBold(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetBorderEnabled()

void PCB_TEXTBOX::SetBorderEnabled ( bool enabled )

Definition at line 953 of file pcb_textbox.cpp.

References m_borderEnabled.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Deserialize(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), and PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC().

◆ SetBorderWidth()

void PCB_TEXTBOX::SetBorderWidth ( const int aSize )

Definition at line 959 of file pcb_textbox.cpp.

References EDA_SHAPE::m_stroke.

Referenced by PCB_TEXTBOX_DESC::PCB_TEXTBOX_DESC().

◆ SetBottom()

void PCB_TEXTBOX::SetBottom ( int aVal )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 310 of file pcb_textbox.cpp.

References ANGLE_180, ANGLE_90, EDA_TEXT::GetDrawRotation(), EDA_SHAPE::SetEndY(), and EDA_SHAPE::SetStartY().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 151 of file eda_item.h.

References BRIGHTENED, and SetFlags().

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

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

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

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

◆ SetEnd()

void PCB_SHAPE::SetEnd ( const VECTOR2I & aEnd )

overridevirtualinherited

Reimplemented from EDA_SHAPE.

Definition at line 921 of file pcb_shape.cpp.

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

◆ SetEndEnding()

void EDA_SHAPE::SetEndEnding ( const LINE_ENDING & aEnding )

inlineinherited

virtual void EDA_SHAPE::SetFilled ( bool aFlag )

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 142 of file eda_shape.h.

References setFilled().

Referenced by FEATURES_MANAGER::AddDimension(), PAD::AddPrimitivePoly(), PAD::AddPrimitivePoly(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), ALLEGRO::BOARD_BUILDER::buildFootprint(), ZONE_CREATE_HELPER::commitZone(), ALTIUM_PCB::ConvertFills6ToBoardItem(), ALTIUM_PCB::ConvertFills6ToFootprintItem(), 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 655 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 698 of file eda_shape.cpp.

References m_fill, and m_hatchingDirty.

Referenced by SCH_IO_ALTIUM::AddLibTextBox(), addOrcadSymbolHatch(), ORCAD_CONVERTER::addSymbolArc(), SCH_IO_GEDA::addSymbolGraphic(), ORCAD_CONVERTER::addSymbolPin(), ORCAD_CONVERTER::addSymbolPrimitive(), SCH_IO_ALTIUM::AddTextBox(), appendGraphicPrimitive(), applyGeometry(), BOOST_AUTO_TEST_CASE(), PADS_SCH::PADS_SCH_SYMBOL_BUILDER::BuildKiCadPowerSymbol(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SCH_IO_LTSPICE_PARSER::CreateRect(), PADS_SCH::PADS_SCH_SYMBOL_BUILDER::createShape(), PADS_SCH::PADS_SCH_SYMBOL_BUILDER::createShapes(), Deserialize(), SCH_TEXTBOX::Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarShape(), fixupSchFillMode(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadArc(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadBezier(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadPolyLine(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadRect(), SCH_IO_EAGLE::loadSymbolPolyLine(), SCH_IO_EAGLE::loadSymbolRectangle(), SCH_IO_EAGLE::loadSymbolWire(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), CONVERT_TOOL::makePolysFromClosedGraphics(), OrcadHatchLines(), SCH_IO_ALTIUM::ParseEllipse(), SCH_IO_KICAD_SEXPR_PARSER::parseEllipseBody(), SCH_IO_KICAD_SEXPR_PARSER::parseSchTextBoxContent(), ORCAD_CONVERTER::placeGraphics(), ORCAD_CONVERTER::placeHierarchicalBlockPinFill(), SCH_IO_PCAD::populateScreen(), PAD::Recombine(), SCH_SHAPE_DESC::SCH_SHAPE_DESC(), SetFillModeProp(), SetLibShapeFillAndColor(), SetSchShapeFillAndColor(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetFillModeProp()

void EDA_SHAPE::SetFillModeProp ( UI_FILL_MODE aFill )

inherited

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

◆ SetFont()

void EDA_TEXT::SetFont ( KIFONT::FONT * aFont )

inherited

Definition at line 458 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by ORCAD_CONVERTER::applyFont(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), 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(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseBoard(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDAPRO_V3_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), ORCAD_CONVERTER::placePageFrame(), SetBold(), SetFontProp(), SetItalic(), FIELDS_GRID_TABLE::SetValue(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetFontProp()

void EDA_TEXT::SetFontProp ( const wxString & aFontName )

inherited

Definition at line 1037 of file eda_text.cpp.

References _, KIFONT::FONT::GetFont(), IsBold(), IsEeschemaType(), IsItalic(), KICAD_FONT_NAME, and SetFont().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

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

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

◆ SetIsProxyItem()

void PCB_SHAPE::SetIsProxyItem ( bool aIsProxy = true )

overridevirtualinherited

Reimplemented from EDA_SHAPE.

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

◆ SetItalic()

void EDA_TEXT::SetItalic ( bool aItalic )

inherited

Set the text to be italic - this will also update the font if needed.

This is the properties system interface.

Definition at line 285 of file eda_text.cpp.

References GetFont(), KIFONT::FONT::GetFont(), IsBold(), isStrokeFont(), m_attributes, SetFont(), and SetItalicFlag().

Referenced by SCH_IO_ALTIUM::AddTextBox(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), ORCAD_CONVERTER::applyFont(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_DRAWING_TOOLS::createNewText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_LABEL_PROPERTIES::OnAddField(), SCH_IO_ALTIUM::ParseLabel(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), PCB_FIELDS_GRID_TABLE::SetValueAsBool(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), SCH_DRAWING_TOOLS::TwoClickPlace(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetItalicFlag()

void EDA_TEXT::SetItalicFlag ( bool aItalic )

inherited

Set only the italic flag, without changing the font.

Used when bulk-changing text attributes (e.g. from a dialog or import).

Definition at line 297 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_KICAD_LEGACY::loadSymbol(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and SetItalic().

◆ SetKeepUpright()

void EDA_TEXT::SetKeepUpright ( bool aKeepUpright )

inherited

◆ SetLayer()

void PCB_SHAPE::SetLayer ( PCB_LAYER_ID aLayer )

overridevirtualinherited

Set the layer this item is on.

Parameters

aLayer The layer number.

Reimplemented from BOARD_CONNECTED_ITEM.

Definition at line 345 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 )

overridevirtualinherited

Reimplemented from BOARD_ITEM.

Definition at line 422 of file pcb_shape.cpp.

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

Referenced by BOOST_AUTO_TEST_CASE().

◆ SetLeft()

void PCB_TEXTBOX::SetLeft ( int aVal )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 321 of file pcb_textbox.cpp.

References ANGLE_180, ANGLE_270, EDA_TEXT::GetDrawRotation(), EDA_SHAPE::SetEndX(), and EDA_SHAPE::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 )

inlineinherited

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

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

inlineinherited

Definition at line 338 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 )

Referenced by BOOST_AUTO_TEST_CASE(), SCH_IO_LTSPICE_PARSER::CreateSCH_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_IO_LTSPICE_PARSER::Parse(), PCB_TEXT::PCB_TEXT(), PCB_TEXTBOX::PCB_TEXTBOX(), ORCAD_CONVERTER::placeGraphics(), SCH_LABEL_BASE::SCH_LABEL_BASE(), SCH_LABEL_BASE::SCH_LABEL_BASE(), SCH_TEXT::SCH_TEXT(), and SCH_TEXTBOX::SCH_TEXTBOX().

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

References BOARD_ITEM::BOARD, BOARD::FindNet(), BOARD_ITEM::GetBoard(), EDA_ITEM::GetFlags(), BOARD::InvalidateClearanceCache(), BOARD_ITEM::IsOnCopperLayer(), BOARD::m_CachesMutex, BOARD::m_ItemNetclassCache, 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.

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

◆ SetParentGroup()

virtual void EDA_ITEM::SetParentGroup ( EDA_GROUP * aGroup )

inlinevirtualinherited

Definition at line 115 of file eda_item.h.

References m_group.

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

◆ SetPolyPoints()

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

inherited

◆ SetPolyShape()

void PCB_SHAPE::SetPolyShape ( const SHAPE_POLY_SET & aShape )

overridevirtualinherited

◆ SetPosition()

void PCB_SHAPE::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 75 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 520 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 350 of file eda_shape.h.

References m_hatchingDirty, m_start, and SetEnd().

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

◆ SetRectangle()

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

inherited

Definition at line 652 of file eda_shape.cpp.

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

◆ SetRectangleHeight()

void EDA_SHAPE::SetRectangleHeight ( const int & aHeight )

inherited

Definition at line 622 of file eda_shape.cpp.

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

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

◆ SetRectangleWidth()

void EDA_SHAPE::SetRectangleWidth ( const int & aWidth )

inherited

Definition at line 637 of file eda_shape.cpp.

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

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

◆ SetRight()

void PCB_TEXTBOX::SetRight ( int aVal )

overridevirtual

Reimplemented from EDA_SHAPE.

Definition at line 332 of file pcb_textbox.cpp.

References ANGLE_180, ANGLE_270, EDA_TEXT::GetDrawRotation(), EDA_SHAPE::SetEndX(), and EDA_SHAPE::SetStartX().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 150 of file eda_item.h.

References SELECTED, and SetFlags().

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

◆ SetShape()

void PCB_TEXTBOX::SetShape ( SHAPE_T aShape )

overridevirtual

Reimplemented from PCB_SHAPE.

Definition at line 225 of file pcb_textbox.cpp.

References PCB_SHAPE::m_libShape, and EDA_SHAPE::SetShape().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent().

◆ SetStart()

void PCB_SHAPE::SetStart ( const VECTOR2I & aStart )

overridevirtualinherited

Reimplemented from EDA_SHAPE.

Definition at line 914 of file pcb_shape.cpp.

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

◆ SetStartEnding()

void EDA_SHAPE::SetStartEnding ( const LINE_ENDING & aEnding )

inlineinherited

void PCB_SHAPE::SetStroke ( const STROKE_PARAMS & aStroke )

◆ SetTextAngleDegrees()

void EDA_TEXT::SetTextAngleDegrees ( double aOrientation )

inlineinherited

Definition at line 181 of file eda_text.h.

References DEGREES_T, and SetTextAngle().

Referenced by PADS_SCH::PADS_SCH_SCHEMATIC_BUILDER::ApplyFieldSettings(), PCB_DIMENSION_BASE::ChangeTextAngleDegrees(), PADS_SCH::PADS_SCH_SCHEMATIC_BUILDER::CreateCustomFields(), createSchText(), PADS_SCH::PADS_SCH_SYMBOL_BUILDER::createSymbolText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseBoard(), SCH_EASYEDA_PARSER::ParseSchematic(), and SCH_EASYEDA_PARSER::ParseSymbolShapes().

◆ SetTextColor()

void EDA_TEXT::SetTextColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 309 of file eda_text.h.

References m_attributes.

Referenced by DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_EASYEDAPRO_V3_PARSER::ParseSymbol(), ORCAD_CONVERTER::placeHierarchicalBlockFields(), ORCAD_CONVERTER::placeOffpageConnectors(), ORCAD_CONVERTER::placePageFrame(), ORCAD_CONVERTER::placePorts(), ORCAD_CONVERTER::placePowerSymbol(), ORCAD_CONVERTER::placeSymbolFields(), FIELDS_GRID_TABLE::SetValue(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int aHeight )

virtualinherited

Definition at line 528 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), m_attributes, m_IuScale, TEXT_MAX_SIZE_MM, and TEXT_MIN_SIZE_MM.

Referenced by CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValue(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const VECTOR2I & aPoint )

virtualinherited

Definition at line 539 of file eda_text.cpp.

References GetTextPos(), Offset(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCAD2KICAD::PCAD_TEXT::AddToBoard(), BOARD_CONSTRAINT_ADAPTER::Apply(), BACK_ANNOTATE::applyChangelist(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), SCH_SHEET::AutoplaceFields(), SCH_FIELD::BeginEdit(), SCH_TEXT::BeginEdit(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_FIXTURE_TEST_CASE(), buildCoincidentFootprint(), SCH_FIELD::CalcEdit(), SCH_TEXT::CalcEdit(), SCH_EDIT_TOOL::ChangeTextType(), Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ORCAD_CONVERTER::kicadSymbolFor(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_IO_EAGLE::loadInstance(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), PCB_DIMENSION_BASE::Mirror(), SCH_TEXT::NormalizeJustification(), PCB_IO_EAGLE::orientFPText(), SCH_IO_ALTIUM::ParseLibParameter(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_TEXT::PCB_TEXT(), DIALOG_CHANGE_SYMBOLS::processSymbols(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), DS_DRAW_ITEM_TEXT::SetPosition(), PCB_TEXT::SetPosition(), SCH_FIELD::SetPosition(), SCH_TEXT::SetPosition(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), EASYEDA_PARSER_BASE::TransformTextToBaseline(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_SYMBOL::UpdateFields(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_CENTER::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ SetTextSize()

void PCB_TEXTBOX::SetTextSize	(	VECTOR2I	aNewSize,
		bool	aEnforceMinTextSize = true )

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 595 of file pcb_textbox.cpp.

References std::abs(), BOARD_ITEM::GetParentFootprint(), TRANSFORM_TRS::GetScaleX(), TRANSFORM_TRS::GetScaleY(), KiROUND(), EDA_TEXT::SetTextSize(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), Build_Board_Characteristics_Table(), Build_Board_Stackup_Table(), and StyleFromSettings().

◆ SetTextThickness()

void PCB_TEXTBOX::SetTextThickness ( int aWidth )

overridevirtual

The TextThickness is that set by the user.

void EDA_TEXT::SetupRenderCache	(	const wxString &	aResolvedText,
		const KIFONT::FONT *	aFont,
		const EDA_ANGLE &	aAngle,
		const VECTOR2I &	aOffset )

inherited

Definition at line 705 of file eda_text.cpp.

References IsMirrored(), and m_render_cache.

◆ SetUuid()

void BOARD_ITEM::SetUuid ( const KIID & aUuid )

inherited

Definition at line 118 of file board_item.cpp.

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

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

◆ SetUuidDirect()

void BOARD_ITEM::SetUuidDirect ( const KIID & aUuid )

inherited

Raw UUID assignment.

No board index maintenance.

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

Definition at line 134 of file board_item.cpp.

References EDA_ITEM::m_Uuid.

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( GR_TEXT_V_ALIGN_T aType )

inherited

Definition at line 373 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), and m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), AdjustTextForSymbolOrientation(), PADS_SCH::PADS_SCH_SCHEMATIC_BUILDER::ApplyFieldSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_SHEET::AutoplaceFields(), FOOTPRINT::AutoPositionFields(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SCH_IO_ALTIUM::CreateAliases(), SCH_DRAWING_TOOLS::createNewText(), createSchText(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EaglePcbTextToKiCadAlignment(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), AUTOPLACER::justifyField(), PCB_TEXT::KeepUpright(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), PCB_IO_PADS::loadFootprints(), PCB_IO_PADS_BINARY::loadFootprints(), SCH_IO_EAGLE::loadFrame(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), SCH_IO_PADS::LoadSchematicFile(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), PCB_IO_EAGLE::packageText(), SCH_IO_LTSPICE_PARSER::Parse(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDAPRO_V3_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_TEXTBOX::PCB_TEXTBOX(), ORCAD_CONVERTER::placePageFrame(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_TEXTBOX::SCH_TEXTBOX(), SCH_FIELD::SetEffectiveVertJustify(), SCH_GLOBALLABEL::SetSpinStyle(), SCH_HIERLABEL::SetSpinStyle(), SCH_LABEL_BASE::SetSpinStyle(), SCH_IO_LTSPICE_PARSER::setTextJustification(), PCAD2KICAD::SetTextJustify(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), SimulateRenderTransform(), SCH_EDIT_TOOL::Swap(), swapFieldPositionsWithMatching(), DIALOG_FIELD_PROPERTIES::UpdateField(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ SetVisible()

void EDA_TEXT::SetVisible ( bool aVisible )

virtualinherited

Definition at line 342 of file eda_text.cpp.

References ClearRenderCache(), and m_visible.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_PROPERTIES_PANEL::addBlankField(), SCH_PROPERTIES_PANEL::addBlankField(), CADSTAR_SCH_ARCHIVE_LOADER::addNewFieldToSymbol(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), BACK_ANNOTATE::applyChangelist(), SYMBOL_FIELDS_EDITOR_GRID_DATA_MODEL::ApplyData(), FOOTPRINT_FIELDS_EDITOR_GRID_DATA_MODEL::applyDataToFootprint(), PADS_SCH::PADS_SCH_SCHEMATIC_BUILDER::ApplyFieldSettings(), SCH_EDITOR_CONTROL::AssignFootprints(), 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(), ALLEGRO::BOARD_BUILDER::buildFootprint(), PADS_SCH::PADS_SCH_SYMBOL_BUILDER::BuildKiCadPowerSymbol(), MULTICHANNEL_TOOL::copyRuleAreaContents(), PADS_SCH::PADS_SCH_SCHEMATIC_BUILDER::CreateCustomFields(), SCH_IO_LTSPICE_PARSER::CreateFields(), DIPTRACE::PCB_PARSER::CreateFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewLabel(), SCH_IO_LTSPICE_PARSER::CreatePowerSymbol(), SCH_IO_LTSPICE_PARSER::CreateSCH_LABEL(), SCH_IO_LTSPICE_PARSER::CreateSCH_TEXT(), DIPTRACE::SCH_PARSER::createSymbolInstance(), EDIT_TOOL::DeleteItems(), PCB_FIELD::Deserialize(), SCH_FIELD::Deserialize(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_IO_EASYEDAPRO_PARSER::FillFootprintModelInfo(), SCH_IO_GEDA::flushPendingComponent(), FOOTPRINT::FOOTPRINT(), SCH_IO_EAGLE::getEagleSymbolFieldAttributes(), SCH_FIELD::ImportValues(), ORCAD_CONVERTER::kicadSymbolFor(), LIB_SYMBOL::LIB_SYMBOL(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), PCB_IO_EAGLE::loadElements(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), FABMASTER::loadFootprints(), PCB_IO_PADS::loadFootprints(), PCB_IO_PADS_BINARY::loadFootprints(), SCH_IO_EAGLE::loadInstance(), SCH_IO_EAGLE::loadLibrary(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_IO_KICAD_LEGACY_LIB_CACHE::LoadPart(), PCB_IO_EAGLE::loadPlain(), SCH_IO_ALTIUM::LoadSchematicFile(), SCH_IO_PADS::LoadSchematicFile(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_IO_EAGLE::loadSymbol(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolFieldAttribute(), SCH_IO_HTTP_LIB::loadSymbolFromPart(), SCH_IO_DATABASE::loadSymbolFromRow(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymbolGateAndPartFields(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), PCB_IO_PADS::loadTestPoints(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadText(), SIM_MODEL::MigrateSimModel(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), SCH_IO_LTSPICE_PARSER::Parse(), PCB_IO_EASYEDAPRO_PARSER::ParseBoard(), PCB_IO_EASYEDAPRO_V3_PARSER::ParseBoard(), SCH_IO_ALTIUM::ParseDesignator(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_ALTIUM::ParseFileName(), PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked(), SCH_IO_ALTIUM::ParseLibParameter(), SCH_IO_ALTIUM::ParseParameter(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_IO_ALTIUM::ParsePortHelper(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_EASYEDAPRO_V3_PARSER::ParseSchematic(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), SCH_IO_ALTIUM::ParseSheetName(), SCH_EASYEDA_PARSER::ParseSymbol(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), SCH_EASYEDAPRO_V3_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), ORCAD_CONVERTER::placeHierarchicalBlockFields(), ORCAD_CONVERTER::placePowerSymbol(), ORCAD_CONVERTER::placeSymbolFields(), SCH_IO_PCAD::populateScreen(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SPRINT_LAYOUT_PARSER::processPad(), DIALOG_CHANGE_SYMBOLS::processSymbols(), processTextItem(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveDcmInfoAsFields(), SCH_FIELD::SCH_FIELD(), SCH_IO_LTSPICE_PARSER::setTextJustification(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), PCB_FIELDS_GRID_TABLE::SetValueAsBool(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow(), SCH_SHEET_PATH::UpdateAllScreenReferences(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetWidth()

void PCB_SHAPE::SetWidth ( int aWidth )

overridevirtualinherited

Reimplemented from EDA_SHAPE.

Definition at line 935 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 155 of file board_item.h.

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

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

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 161 of file board_item.h.

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

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

◆ SHAPE_T_asString()

wxString EDA_SHAPE::SHAPE_T_asString ( ) const

inherited

Definition at line 501 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(), 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(), makeEffectiveShapes(), SCH_POINT_EDITOR::makePointsAndBehavior(), move(), operator=(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotShape(), rotate(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), SCH_IO_KICAD_SEXPR::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 4239 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,
		bool	aClosed,
		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 4451 of file eda_shape.cpp.

References 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 4352 of file eda_shape.cpp.

References BEZIER, bezierLength(), findBezierTAtLength(), m_bezierC1, m_bezierC2, m_end, m_endEnding, m_shape, m_start, and m_startEnding.

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 4380 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 4399 of file eda_shape.cpp.

References m_endEnding, and m_startEnding.

Referenced by BOOST_AUTO_TEST_CASE(), 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 4199 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(), BRDITEMS_PLOTTER::PlotShape(), and TransformWithLineEndingsToPolygon().

◆ ShowShape()

wxString EDA_SHAPE::ShowShape ( ) const

inherited

Definition at line 472 of file eda_shape.cpp.

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

Referenced by operator=().

◆ Similarity() [1/3]

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

inherited

Definition at line 3879 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/3]

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

inherited

Definition at line 1287 of file eda_text.cpp.

References EDA_TEXT(), Levenshtein(), m_attributes, and m_pos.

Referenced by PCB_DIMENSION_BASE::Similarity(), PCB_FIELD::Similarity(), PCB_TEXT::Similarity(), PCB_TEXTBOX::Similarity(), SCH_FIELD::Similarity(), SCH_TEXT::Similarity(), and SCH_TEXTBOX::Similarity().

◆ Similarity() [3/3]

double PCB_TEXTBOX::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.

Reimplemented from PCB_SHAPE.

Definition at line 982 of file pcb_textbox.cpp.

References BOARD_ITEM::BOARD_ITEM(), GetMarginBottom(), GetMarginLeft(), GetMarginRight(), GetMarginTop(), m_borderEnabled, PCB_TEXTBOX(), EDA_TEXT::Similarity(), and EDA_ITEM::Type().

Referenced by PCB_TABLECELL::Similarity().

◆ Sort()

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

inlinestaticinherited

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

Parameters

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

Returns: True if aLeft is less than aRight.

Definition at line 538 of file eda_item.h.

References EDA_ITEM().

◆ StyleFromSettings()

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

overridevirtual

Reimplemented from PCB_SHAPE.

Definition at line 171 of file pcb_textbox.cpp.

References BOARD_ITEM::BOARD, BOARD_ITEM::GetBoard(), PCB_SHAPE::GetLayer(), BOARD_ITEM::GetParentFootprint(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), BOARD_DESIGN_SETTINGS::GetTextUpright(), IsBackLayer(), EDA_TEXT::SetItalic(), EDA_TEXT::SetKeepUpright(), EDA_TEXT::SetMirrored(), SetTextSize(), SetTextThickness(), and PCB_SHAPE::StyleFromSettings().

◆ SwapAttributes()

void EDA_TEXT::SwapAttributes ( EDA_TEXT & aTradingPartner )

inherited

Swap the text attributes of the two involved instances.

Definition at line 409 of file eda_text.cpp.

References ClearBoundingBoxCache(), ClearRenderCache(), EDA_TEXT(), m_attributes, and m_pos.

Referenced by SCH_FIELD::swapData(), SCH_TEXT::swapData(), and SCH_TEXTBOX::swapData().

◆ swapData()

void PCB_TEXTBOX::swapData ( BOARD_ITEM * aImage )

overrideprotectedvirtual

Reimplemented from PCB_SHAPE.

Reimplemented in PCB_TABLECELL.

Definition at line 819 of file pcb_textbox.cpp.

References BOARD_ITEM::BOARD_ITEM(), PCB_TEXTBOX(), PCB_TEXTBOX_T, and EDA_ITEM::Type().

◆ SwapItemData()

void BOARD_ITEM::SwapItemData ( BOARD_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

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

Parameters

aImage the item image which contains data to swap.

Definition at line 320 of file board_item.cpp.

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

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

◆ SwapShape()

void EDA_SHAPE::SwapShape ( EDA_SHAPE * aImage )

inherited

Definition at line 3436 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 operator=(), PCB_SHAPE::swapData(), and SCH_SHAPE::swapData().

◆ SwapText()

void EDA_TEXT::SwapText ( EDA_TEXT & aTradingPartner )

inherited

Definition at line 401 of file eda_text.cpp.

References cacheShownText(), EDA_TEXT(), and m_text.

Referenced by SCH_FIELD::swapData(), SCH_TEXT::swapData(), and SCH_TEXTBOX::swapData().

◆ syncLibCoords()

void PCB_TEXTBOX::syncLibCoords ( )

overrideprotectedvirtual

Reimplemented from PCB_SHAPE.

Definition at line 722 of file pcb_textbox.cpp.

References std::abs(), BOARD_ITEM::GetParentFootprint(), TRANSFORM_TRS::GetScaleX(), TRANSFORM_TRS::GetScaleY(), EDA_SHAPE::GetShape(), FOOTPRINT::GetTransform(), TRANSFORM_TRS::InverseApply(), KiROUND(), EDA_SHAPE::m_end, PCB_SHAPE::m_libEnd, PCB_SHAPE::m_libStart, EDA_SHAPE::m_start, RECTANGLE, PCB_SHAPE::syncLibCoords(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by Rotate().

◆ TextHitTest() [1/2]

bool EDA_TEXT::TextHitTest	(	const BOX2I &	aRect,
		bool	aContains,
		int	aAccuracy = 0 ) const

virtualinherited

Test if object bounding box is contained within or intersects aRect.

Parameters

aRect	Rect to test against.
aContains	Test for containment instead of intersection if true.
aAccuracy	Amount to inflate the bounding box.

Returns: true if a hit, else false.

Reimplemented in PCB_TEXT.

Definition at line 881 of file eda_text.cpp.

References BOX2< Vec >::Contains(), GetDrawRotation(), BOX2< Vec >::GetInflated(), GetTextBox(), and BOX2< Vec >::Intersects().

◆ TextHitTest() [2/2]

bool EDA_TEXT::TextHitTest	(	const VECTOR2I &	aPoint,
		int	aAccuracy = 0 ) const

virtualinherited

Test if aPoint is within the bounds of this object.

Parameters

aPoint	A VECTOR2I to test.
aAccuracy	Amount to inflate the bounding box.

Returns: true if a hit, else false.

Reimplemented in PCB_TEXT.

Definition at line 873 of file eda_text.cpp.

References BOX2< Vec >::Contains(), GetDrawPos(), GetDrawRotation(), BOX2< Vec >::GetInflated(), GetRotated(), GetTextBox(), and location.

Referenced by DS_DRAW_ITEM_TEXT::HitTest(), DS_DRAW_ITEM_TEXT::HitTest(), and PCB_TEXT::TextHitTest().

◆ transformFp()

const FOOTPRINT * PCB_SHAPE::transformFp ( ) const

protectedinherited

Definition at line 614 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 2776 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

Definition at line 3538 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_TEXTBOX::TransformShapeToPolygon	(	SHAPE_POLY_SET &	aBuffer,
		PCB_LAYER_ID	aLayer,
		int	aClearance,
		int	aError,
		ERROR_LOC	aErrorLoc,
		bool	ignoreLineWidth = false ) const

overridevirtual

Convert the shape to a closed polygon.

Circles and arcs are approximated by segments.

Parameters

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

Reimplemented from PCB_SHAPE.

Definition at line 900 of file pcb_textbox.cpp.

References SEG::A, SHAPE_POLY_SET::Append(), SEG::B, SHAPE_LINE_CHAIN::GetPoint(), EDA_SHAPE::GetPolyShape(), EDA_SHAPE::GetRectCorners(), SHAPE_LINE_CHAIN::GetSegment(), EDA_SHAPE::GetShape(), PCB_SHAPE::GetWidth(), m_borderEnabled, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), SHAPE_LINE_CHAIN::PointCount(), POLY, RECTANGLE, SHAPE_LINE_CHAIN::SegmentCount(), and TransformOvalToPolygon().

Referenced by TransformTextToPolySet().

◆ 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

overridevirtualinherited

Convert the item shape to a polyset.

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

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 1749 of file pcb_shape.cpp.

References EDA_SHAPE::TransformShapeToPolygon().

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

◆ TransformTextToPolySet()

void PCB_TEXTBOX::TransformTextToPolySet	(	SHAPE_POLY_SET &	aBuffer,
		int	aClearance,
		int	aMaxError,
		ERROR_LOC	aErrorLoc ) const

Function TransformTextToPolySet Convert the text to a polygonSet describing the actual character strokes (one per segment).

Used in 3D viewer Circles and arcs are approximated by segments

Parameters

aBuffer	= SHAPE_POLY_SET to store the polygon corners
aClearance	= the clearance around the text
aMaxError	= the maximum error to allow when approximating curves

Definition at line 839 of file pcb_textbox.cpp.

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::BooleanSubtract(), KIFONT::FONT::Draw(), KIGFX::GAL::DrawGlyphs(), ERROR_OUTSIDE, FOR_CANVAS, EDA_TEXT::GetAttributes(), EDA_TEXT::GetDrawFont(), GetDrawPos(), EDA_TEXT::GetEffectiveTextPenWidth(), BOARD_ITEM::GetFontMetrics(), PCB_SHAPE::GetLayer(), EDA_TEXT::GetRenderCache(), GetShownText(), SHAPE_POLY_SET::Inflate(), BOARD_ITEM::IsKnockout(), SHAPE_POLY_SET::NewOutline(), ROUND_ALL_CORNERS, SHAPE_POLY_SET::Simplify(), TransformOvalToPolygon(), and TransformShapeToPolygon().

Referenced by FEATURES_MANAGER::AddText(), PCB_TABLE::Autosize(), EXPORTER_STEP::buildGraphic3DShape(), BOARD::ConvertBrdLayerToPolygonalContours(), BOARD_ADAPTER::createLayers(), KIGFX::PCB_PAINTER::draw(), FOOTPRINT::GetCoverageArea(), BRDITEMS_PLOTTER::PlotText(), FOOTPRINT::TransformFPShapesToPolySet(), and transformFPTextToPolySet().

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

References ARC, BEZIER, CalcArcAngles(), SHAPE_POLY_SET::COutline(), end, SHAPE_ARC::GetArcMid(), GetEffectiveWidth(), GetEnd(), 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(), and EXPORTER_STEP::buildGraphic3DShape().

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

References BOARD_ITEM::BOARD, 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

overridevirtualinherited

Reimplemented from EDA_SHAPE.

Definition at line 532 of file pcb_shape.cpp.

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

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

◆ ValidateHyperlink()

bool EDA_TEXT::ValidateHyperlink ( const wxString & aURL )

staticinherited

Check if aURL is a valid hyperlink.

Parameters

aURL	String to validate

Returns: true if aURL is a valid hyperlink

Definition at line 1232 of file eda_text.cpp.

References IsGotoPageHref().

Referenced by SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ ViewBBox()

const BOX2I PCB_SHAPE::ViewBBox ( ) const

overridevirtualinherited

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

Returns: the current bounding box.

Reimplemented from EDA_ITEM.

Definition at line 1660 of file pcb_shape.cpp.

References GetWidth(), BOX2< Vec >::Inflate(), and EDA_ITEM::ViewBBox().

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

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

Reimplemented in 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_TEXTBOX::ViewGetLayers ( ) const

overridevirtual

Reimplemented from PCB_SHAPE.

Definition at line 482 of file pcb_textbox.cpp.

References PCB_SHAPE::GetLayer(), BOARD_ITEM::GetParentFootprint(), BOARD_ITEM::IsLocked(), and LAYER_LOCKED_ITEM_SHADOW.

◆ ViewGetLOD()

double PCB_TEXTBOX::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 PCB_SHAPE.

Definition at line 459 of file pcb_textbox.cpp.

References KIGFX::RENDER_SETTINGS::GetHighContrast(), KIGFX::VIEW::GetPainter(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), KIGFX::PCB_PAINTER::GetSettings(), KIGFX::VIEW::IsLayerVisibleCached(), LAYER_LOCKED_ITEM_SHADOW, KIGFX::VIEW_ITEM::LOD_HIDE, KIGFX::VIEW_ITEM::LOD_SHOW, and BOARD_ITEM::m_layer.

◆ viewPrivData()

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

inlineinherited

◆ Visit()

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

virtualinherited

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

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

Parameters

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

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

Reimplemented in BOARD, FOOTPRINT, GBR_LAYOUT, GERBER_DRAW_ITEM, GERBER_FILE_IMAGE, LIB_SYMBOL, PCB_DRILL_CHART, 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.

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

◆ LOD_SHOW

double KIGFX::VIEW_ITEM::LOD_SHOW = 0.0

staticconstexprprotectedinherited

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

Definition at line 181 of file view_item.h.

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

◆ m_activeUrl

wxString EDA_TEXT::m_activeUrl

mutableprotectedinherited

Definition at line 503 of file eda_text.h.

Referenced by SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), SCH_TEXT::HasHoveredHypertext(), SCH_TEXTBOX::HasHoveredHypertext(), and SetActiveUrl().

◆ m_arcCenter

VECTOR2I EDA_SHAPE::m_arcCenter

protectedinherited

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

BOARD* BOARD_ITEM::m_boardCacheOwner = nullptr

mutableprotectedinherited

Definition at line 576 of file board_item.h.

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

◆ m_borderEnabled

bool PCB_TEXTBOX::m_borderEnabled

protected

Controls drawing the border (as defined by the stroke members)

Definition at line 224 of file pcb_textbox.h.

Referenced by IsBorderEnabled(), operator==(), PCB_TEXTBOX(), SetBorderEnabled(), Similarity(), and TransformShapeToPolygon().

◆ m_cornerRadius

int EDA_SHAPE::m_cornerRadius

protectedinherited

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

Definition at line 615 of file eda_item.h.

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

◆ m_dynamicCustomPropsCache

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

mutableprotectedinherited

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

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

Definition at line 621 of file eda_item.h.

Referenced by GetCustomPropertiesAsInspectables(), and RemoveCustomProperty().

◆ m_editState

int EDA_SHAPE::m_editState

protectedinherited

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

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 206 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 612 of file eda_item.h.

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

◆ m_group

EDA_GROUP* EDA_ITEM::m_group

protectedinherited

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

Definition at line 608 of file eda_item.h.

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

◆ m_hasSolderMask

bool PCB_SHAPE::m_hasSolderMask

protectedinherited

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

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

◆ m_hatchingDirty

bool EDA_SHAPE::m_hatchingDirty

mutableprotectedinherited

◆ m_hyperlink

wxString EDA_TEXT::m_hyperlink

protectedinherited

std::optional<int> PCB_SHAPE::m_solderMaskMargin

protectedinherited

Definition at line 372 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 603 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_text

wxString EDA_TEXT::m_text

privateinherited

Definition at line 506 of file eda_text.h.

Referenced by cacheShownText(), Compare(), CopyText(), EDA_TEXT(), EDA_TEXT(), Empty(), GetShownText(), GetText(), operator=(), Replace(), SetText(), and SwapText().

◆ m_text_var_refs

std::vector<TEXT_VAR_REF_KEY> EDA_TEXT::m_text_var_refs

privateinherited

Definition at line 514 of file eda_text.h.

Referenced by cacheShownText(), EDA_TEXT(), GetTextVarReferences(), and operator=().

◆ m_unresolvedFontName

wxString EDA_TEXT::m_unresolvedFontName

privateinherited

Definition at line 530 of file eda_text.h.

Referenced by EDA_TEXT(), GetUnresolvedFontName(), isStrokeFont(), operator=(), ResolveFont(), and SetUnresolvedFontName().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 597 of file eda_item.h.

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 205 of file view_item.h.

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

◆ m_visible

bool EDA_TEXT::m_visible

privateinherited

Definition at line 532 of file eda_text.h.

Referenced by EDA_TEXT(), EDA_TEXT(), IsVisible(), operator=(), and SetVisible().

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

Definition at line 232 of file board_item.h.

Referenced by BOARD::GetPosition().

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

Constructor & Destructor Documentation

◆ PCB_TEXTBOX()

◆ ~PCB_TEXTBOX()

Member Function Documentation

◆ AddRenderCacheGlyph()

◆ BeginEdit()

◆ beginEdit()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ buildBezierToSegmentsPointsList()

◆ buildShapeEllipse()

◆ cacheShownText()

◆ CalcArcAngles()

◆ CalcEdit()

◆ calcEdit()

◆ ClassOf()

◆ ClearBoundingBoxCache()

◆ ClearBrightened()

◆ ClearCustomProperties()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearRenderCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Compare() [1/2]

◆ Compare() [2/2]

◆ computeArcBBox()

◆ containsURL()

◆ ContinueEdit()

◆ continueEdit()

◆ CopyFrom()

◆ CopyText()

◆ DeleteStructure()

◆ Deserialize() [1/6]

◆ Deserialize() [2/6]

◆ Deserialize() [3/6]

◆ Deserialize() [4/6]

◆ Deserialize() [5/6]

◆ Deserialize() [6/6]

◆ DisambiguateItemDescription()

◆ Duplicate()

◆ Empty()

◆ EndEdit()

◆ endEdit()

◆ EndsSwapped()

◆ EvaluateText()

◆ findParent()

◆ FitsEnabledLayers()

◆ Flip()

◆ flip()

◆ FlipHJustify()

◆ Format()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetArcAngle()

◆ GetArcMid()

◆ GetAttributes()

◆ GetAutoThickness()

◆ GetBezierC1()

◆ GetBezierC2()

◆ GetBezierPoints()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBorderWidth()