A radial dimension indicates either the radius or diameter of an arc or circle. More...

#include <pcb_dimension.h>

Inheritance diagram for PCB_DIM_RADIAL:

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

Public Member Functions
	PCB_DIM_RADIAL (BOARD_ITEM *aParent)

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.

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

void	SetLeaderLength (int aLength)

int	GetLeaderLength () const

void	ChangeLeaderLength (int aLength)

VECTOR2I	GetKnee () const

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

wxString	GetClass () const override
	Return the class name.

virtual const VECTOR2I &	GetStart () const
	The dimension's origin is the first feature point for the dimension.

virtual void	SetStart (const VECTOR2I &aPoint)

virtual const VECTOR2I &	GetEnd () const

virtual void	SetEnd (const VECTOR2I &aPoint)

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPos) override

bool	GetOverrideTextEnabled () const

void	SetOverrideTextEnabled (bool aOverride)

wxString	GetOverrideText () const

void	SetOverrideText (const wxString &aValue)

void	ChangeOverrideText (const wxString &aValue)

int	GetMeasuredValue () const

void	SetMeasuredValue (int aValue)

wxString	GetValueText () const

void	Update ()
	Update the dimension's cached text and geometry.

void	UpdateUnits ()

wxString	GetPrefix () const

void	SetPrefix (const wxString &aPrefix)

void	ChangePrefix (const wxString &aPrefix)

wxString	GetSuffix () const

void	SetSuffix (const wxString &aSuffix)

void	ChangeSuffix (const wxString &aSuffix)

DIM_ARROW_DIRECTION	GetArrowDirection () const

void	SetArrowDirection (const DIM_ARROW_DIRECTION &aDirection)

void	ChangeArrowDirection (const DIM_ARROW_DIRECTION &aDirection)

EDA_UNITS	GetUnits () const

void	SetUnits (EDA_UNITS aUnits)

DIM_UNITS_MODE	GetUnitsMode () const

void	SetUnitsMode (DIM_UNITS_MODE aMode)

void	ChangeUnitsMode (DIM_UNITS_MODE aMode)

void	SetAutoUnits (bool aAuto=true)

DIM_UNITS_FORMAT	GetUnitsFormat () const

void	SetUnitsFormat (const DIM_UNITS_FORMAT aFormat)

void	ChangeUnitsFormat (const DIM_UNITS_FORMAT aFormat)

DIM_PRECISION	GetPrecision () const

void	SetPrecision (DIM_PRECISION aPrecision)

void	ChangePrecision (DIM_PRECISION aPrecision)

bool	GetSuppressZeroes () const

void	SetSuppressZeroes (bool aSuppress)

void	ChangeSuppressZeroes (bool aSuppress)

bool	GetKeepTextAligned () const

void	SetKeepTextAligned (bool aKeepAligned)

double	GetTextAngleDegreesProp () const

void	ChangeTextAngleDegrees (double aDegrees)

void	ChangeKeepTextAligned (bool aKeepAligned)

void	SetTextPositionMode (DIM_TEXT_POSITION aMode)

DIM_TEXT_POSITION	GetTextPositionMode () const

int	GetArrowLength () const

void	SetArrowLength (int aLength)

void	SetExtensionOffset (int aOffset)

int	GetExtensionOffset () const

int	GetLineThickness () const

void	SetLineThickness (int aWidth)

const std::vector< std::shared_ptr< SHAPE > > &	GetShapes () const

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

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

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

virtual void	Mirror (const VECTOR2I &axis_pos, FLIP_DIRECTION aFlipDirection) override
	Mirror the dimension relative to a given horizontal axis.

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

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

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

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

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

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

void	ClearRenderCache () override

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

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

double	Similarity (const EDA_TEXT &aOther) const

bool	operator== (const PCB_DIMENSION_BASE &aOther) const

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

bool	operator== (const PCB_TEXT &aOther) const

bool	operator== (const EDA_TEXT &aRhs) const

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

void	StyleFromSettings (const BOARD_DESIGN_SETTINGS &settings) override

void	KeepUpright ()
	Called when rotating the parent footprint.

wxString	GetShownText (bool aAllowExtraText, 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.

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

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

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

virtual wxString	GetTextTypeDescription () const

EDA_ANGLE	GetDrawRotation () const override

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

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

void	SetParentGroup (PCB_GROUP *aGroup)

PCB_GROUP *	GetParentGroup () const

int	GetX () const

int	GetY () const

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

void	SetX (int aX)

void	SetY (int aY)

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

virtual bool	IsOnCopperLayer () const

virtual bool	HasHole () const

virtual bool	HasDrilledHole () const

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

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

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

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

BOARD_ITEM_CONTAINER *	GetParent () const

FOOTPRINT *	GetParentFootprint () const

VECTOR2I	GetFPRelativePosition () const

void	SetFPRelativePosition (const VECTOR2I &aPos)

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

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

const KIFONT::METRICS &	GetFontMetrics () const

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

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

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

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

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

virtual void	SetLayerSet (const LSET &aLayers)

bool	IsSideSpecific () const

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

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

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

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

virtual bool	IsKnockout () const

virtual void	SetIsKnockout (bool aKnockout)

virtual bool	IsLocked () const

virtual void	SetLocked (bool aLocked)

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

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

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

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

virtual BOARD *	GetBoard ()

wxString	GetParentAsString () const
	For "parent" property.

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

KICAD_T	Type () const
	Returns the type of object.

virtual void	SetParent (EDA_ITEM *aParent)

bool	IsModified () const

bool	IsNew () const

bool	IsMoving () const

bool	IsSelected () const

bool	IsEntered () const

bool	IsBrightened () const

bool	IsRollover () const

void	SetSelected ()

void	SetBrightened ()

void	ClearSelected ()

void	ClearBrightened ()

void	SetModified ()

void	SetFlags (EDA_ITEM_FLAGS aMask)

void	XorFlags (EDA_ITEM_FLAGS aMask)

void	ClearFlags (EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

EDA_ITEM_FLAGS	GetFlags () const

bool	HasFlag (EDA_ITEM_FLAGS aFlag) const

EDA_ITEM_FLAGS	GetEditFlags () const

virtual void	ClearEditFlags ()

EDA_ITEM_FLAGS	GetTempFlags () const

virtual void	ClearTempFlags ()

virtual bool	RenderAsBitmap (double aWorldScale) const

void	SetIsShownAsBitmap (bool aBitmap)

bool	IsShownAsBitmap () const

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

bool	IsForceVisible () const

virtual wxString	GetFriendlyName () const

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

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

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

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

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

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

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.

bool	operator< (const EDA_TEXT &aRhs) const

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)

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

wxAny	Get (PROPERTY_BASE *aProperty) const

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

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

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

virtual void	SetText (const wxString &aText)

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

int	GetTextThickness () const

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

virtual void	SetTextAngle (const EDA_ANGLE &aAngle)

const EDA_ANGLE &	GetTextAngle () const

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 italic flag, without changing the font.

bool	IsBold () const

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

void	SetFont (KIFONT::FONT *aFont)

KIFONT::FONT *	GetFont () const

wxString	GetFontName () const

void	SetFontIndex (int aIdx)

int	GetFontIndex () const

void	SetLineSpacing (double aLineSpacing)

double	GetLineSpacing () const

void	SetTextSize (VECTOR2I aNewSize, bool aEnforceMinTextSize=true)

VECTOR2I	GetTextSize () const

void	SetTextWidth (int aWidth)

int	GetTextWidth () const

void	SetTextHeight (int aHeight)

int	GetTextHeight () const

void	SetTextColor (const COLOR4D &aColor)

COLOR4D	GetTextColor () const

void	SetTextPos (const VECTOR2I &aPoint)

const VECTOR2I &	GetTextPos () const

void	SetTextX (int aX)

void	SetTextY (int aY)

void	Offset (const VECTOR2I &aOffset)

void	Empty ()

void	Print (const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor, OUTLINE_MODE aDisplay_mode=FILLED)
	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.

BOX2I	GetTextBox (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
	Return the distance between two lines of text.

wxString	GetTextStyleName () const

void	GetLinePositions (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.

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

virtual VECTOR2I	GetDrawPos () const

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

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 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
virtual void	swapData (BOARD_ITEM *aImage) override

void	updateText () override
	Update the text field value from the current geometry (called by updateGeometry normally).

void	updateGeometry () override
	Update the cached geometry of the dimension after changing any of its properties.

template<typename ShapeType >
void	addShape (const ShapeType &aShape)

void	drawAnArrow (VECTOR2I aStartPoint, EDA_ANGLE anAngle, int aLength)
	Draws an arrow and updates the shape container.

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

void	buildBoundingHull (SHAPE_POLY_SET *aBuffer, const SHAPE_POLY_SET &aRenderedText, int aClearance) const
	Build a nominally rectangular bounding box for the rendered text.

int	getKnockoutMargin () const

const KIFONT::METRICS &	getFontMetrics () const override

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

virtual KIFONT::FONT *	getDrawFont () const

virtual void	cacheShownText ()

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

Protected Attributes
bool	m_overrideTextEnabled
	Manually specify the displayed measurement value.

wxString	m_valueString
	Displayed value when m_overrideValue = true.

wxString	m_prefix
	String prepended to the value.

wxString	m_suffix
	String appended to the value.

EDA_UNITS	m_units
	0 = inches, 1 = mm

bool	m_autoUnits
	If true, follow the currently selected UI units.

DIM_UNITS_FORMAT	m_unitsFormat
	How to render the units suffix.

DIM_ARROW_DIRECTION	m_arrowDirection
	direction of dimension arrow.

DIM_PRECISION	m_precision
	Number of digits to display after decimal.

bool	m_suppressZeroes
	Suppress trailing zeroes.

int	m_lineThickness
	Thickness used for all graphics in the dimension.

int	m_arrowLength
	Length of arrow shapes.

int	m_extensionOffset
	Distance from feature points to extension line start.

DIM_TEXT_POSITION	m_textPosition
	How to position the text.

bool	m_keepTextAligned
	Calculate text orientation to match dimension.

int	m_measuredValue
	value of PCB dimensions

VECTOR2I	m_start

VECTOR2I	m_end
	Internal cache of drawn shapes.

std::vector< std::shared_ptr< SHAPE > >	m_shapes

bool	m_inClearRenderCache
	re-entrancy guard

PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_flags

EDA_ITEM *	m_parent
	Linked list: Link (parent struct)

bool	m_forceVisible

wxString	m_hyperlink
	A hyperlink URL.

Private Attributes
int	m_leaderLength

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

std::reference_wrapper< const EDA_IU_SCALE >	m_IuScale

wxString	m_render_cache_text

const KIFONT::FONT *	m_render_cache_font

EDA_ANGLE	m_render_cache_angle

VECTOR2I	m_render_cache_offset

std::vector< std::unique_ptr< KIFONT::GLYPH > >	m_render_cache

bool	m_bounding_box_cache_valid

VECTOR2I	m_bounding_box_cache_pos

int	m_bounding_box_cache_line

BOX2I	m_bounding_box_cache

TEXT_ATTRIBUTES	m_attributes

VECTOR2I	m_pos

Detailed Description

A radial dimension indicates either the radius or diameter of an arc or circle.

A guide to the geometry of a circle dimension:

–a– |

     b_
     |\
       \
        c---d TEXT

Point a (the center of the arc or circle) is m_start, point b (a point on the arc or circle) is m_end, point c is m_leaderLength away from b on the a-b vector, and point d is the end of the "text line". The c-d line is drawn from c to the text center, and clipped on the text bounding box.

Definition at line 582 of file pcb_dimension.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum BOARD_ITEM::COMPARE_FLAGS : int

inherited

Enumerator
DRC

Definition at line 417 of file board_item.h.

Constructor & Destructor Documentation

◆ PCB_DIM_RADIAL()

PCB_DIM_RADIAL::PCB_DIM_RADIAL ( BOARD_ITEM * aParent )

Definition at line 1461 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_arrowLength, PCB_DIMENSION_BASE::m_keepTextAligned, m_leaderLength, PCB_DIMENSION_BASE::m_overrideTextEnabled, PCB_DIMENSION_BASE::m_prefix, and PCB_DIMENSION_BASE::m_unitsFormat.

Member Function Documentation

◆ AddRenderCacheGlyph()

void EDA_TEXT::AddRenderCacheGlyph ( const SHAPE_POLY_SET & aPoly )

inherited

Definition at line 690 of file eda_text.cpp.

References EDA_TEXT::m_render_cache.

◆ addShape()

template<typename ShapeType >

void PCB_DIMENSION_BASE::addShape ( const ShapeType & aShape )

protectedinherited

Definition at line 399 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_shapes.

Referenced by PCB_DIM_ALIGNED::updateGeometry(), and PCB_DIM_ORTHOGONAL::updateGeometry().

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

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

Referenced by PAD::ClearZoneLayerOverrides(), PCB_VIA::ClearZoneLayerOverrides(), PAD::Flip(), PADSTACK::ForEachUniqueLayer(), PCB_VIA::GetLayerSet(), PAD::PAD(), PCB_VIA::PCB_VIA(), PADSTACK::RelevantShapeLayers(), PNS_KICAD_IFACE_BASE::syncPad(), and PADSTACK::UniqueLayers().

◆ BoardLayerCount()

int BOARD_ITEM::BoardLayerCount ( ) const

virtualinherited

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

Definition at line 106 of file board_item.cpp.

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

◆ BoardLayerSet()

LSET BOARD_ITEM::BoardLayerSet ( ) const

virtualinherited

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

Definition at line 128 of file board_item.cpp.

References LSET::AllLayersMask(), BOARD_ITEM::GetBoard(), and BOARD_ITEM::GetLayerSet().

Referenced by PADSTACK::EffectiveLayerFor().

◆ buildBoundingHull()

void PCB_TEXT::buildBoundingHull	(	SHAPE_POLY_SET *	aBuffer,
		const SHAPE_POLY_SET &	aRenderedText,
		int	aClearance
	)		const

protectedinherited

Build a nominally rectangular bounding box for the rendered text.

(It's not a BOX2I because it will be a diamond shape for non-cardinally rotated text.)

Definition at line 481 of file pcb_text.cpp.

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::BBox(), BOX2< Vec >::GetBottom(), EDA_TEXT::GetDrawPos(), PCB_TEXT::GetDrawRotation(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetRight(), SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Rotate(), RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_TEXT::TransformShapeToPolygon(), and PCB_TEXT::TransformTextToPolySet().

◆ cacheShownText()

void EDA_TEXT::cacheShownText ( )

protectedvirtualinherited

Reimplemented in SCH_LABEL_BASE.

Definition at line 596 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_bounding_box_cache_valid, EDA_TEXT::m_shown_text, EDA_TEXT::m_shown_text_has_text_var_refs, EDA_TEXT::m_text, and UnescapeString().

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

◆ ChangeArrowDirection()

void PCB_DIMENSION_BASE::ChangeArrowDirection ( const DIM_ARROW_DIRECTION & aDirection )

inlineinherited

Definition at line 206 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::SetArrowDirection(), PCB_DIMENSION_BASE::updateGeometry(), and PCB_DIMENSION_BASE::updateText().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ChangeKeepTextAligned()

void PCB_DIMENSION_BASE::ChangeKeepTextAligned ( bool aKeepAligned )

inherited

Definition at line 519 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::SetKeepTextAligned(), and PCB_DIMENSION_BASE::Update().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ChangeLeaderLength()

void PCB_DIM_RADIAL::ChangeLeaderLength ( int aLength )

inline

Definition at line 600 of file pcb_dimension.h.

References SetLeaderLength(), and PCB_DIMENSION_BASE::Update().

Referenced by RADIAL_DIMENSION_DESC::RADIAL_DIMENSION_DESC().

◆ ChangeOverrideText()

void PCB_DIMENSION_BASE::ChangeOverrideText ( const wxString & aValue )

inlineinherited

Definition at line 146 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::SetOverrideText(), PCB_DIMENSION_BASE::SetOverrideTextEnabled(), and PCB_DIMENSION_BASE::Update().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ChangePrecision()

void PCB_DIMENSION_BASE::ChangePrecision ( DIM_PRECISION aPrecision )

inlineinherited

Definition at line 239 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::SetPrecision(), and PCB_DIMENSION_BASE::Update().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ChangePrefix()

void PCB_DIMENSION_BASE::ChangePrefix ( const wxString & aPrefix )

inlineinherited

Definition at line 185 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::SetPrefix(), and PCB_DIMENSION_BASE::Update().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ChangeSuffix()

void PCB_DIMENSION_BASE::ChangeSuffix ( const wxString & aSuffix )

inlineinherited

Definition at line 194 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::SetSuffix(), and PCB_DIMENSION_BASE::Update().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ChangeSuppressZeroes()

void PCB_DIMENSION_BASE::ChangeSuppressZeroes ( bool aSuppress )

inlineinherited

Definition at line 248 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::SetSuppressZeroes(), and PCB_DIMENSION_BASE::Update().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ChangeTextAngleDegrees()

void PCB_DIMENSION_BASE::ChangeTextAngleDegrees ( double aDegrees )

inherited

Definition at line 511 of file pcb_dimension.cpp.

References EDA_TEXT::SetTextAngleDegrees(), and PCB_DIMENSION_BASE::Update().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ChangeUnitsFormat()

void PCB_DIMENSION_BASE::ChangeUnitsFormat ( const DIM_UNITS_FORMAT aFormat )

inlineinherited

Definition at line 230 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::SetUnitsFormat(), and PCB_DIMENSION_BASE::Update().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ChangeUnitsMode()

void PCB_DIMENSION_BASE::ChangeUnitsMode ( DIM_UNITS_MODE aMode )

inlineinherited

Definition at line 219 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::SetUnitsMode(), and PCB_DIMENSION_BASE::Update().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ ClassOf()

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

inlinestatic

Definition at line 590 of file pcb_dimension.h.

References PCB_DIM_RADIAL_T, and EDA_ITEM::Type().

◆ ClearBoundingBoxCache()

void EDA_TEXT::ClearBoundingBoxCache ( )

virtualinherited

Definition at line 637 of file eda_text.cpp.

References EDA_TEXT::m_bounding_box_cache_valid.

Referenced by SCH_FIELD::ClearCaches(), EESCHEMA_HELPERS::LoadSchematic(), SCH_EDIT_FRAME::RecomputeIntersheetRefs(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 123 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

virtual void EDA_ITEM::ClearEditFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 141 of file eda_item.h.

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

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

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 129 of file eda_item.h.

References EDA_ITEM::m_flags.

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

◆ ClearRenderCache()

void PCB_DIMENSION_BASE::ClearRenderCache ( )

overridevirtualinherited

Reimplemented from EDA_TEXT.

Definition at line 382 of file pcb_dimension.cpp.

References EDA_TEXT::ClearRenderCache(), PCB_DIMENSION_BASE::m_inClearRenderCache, and PCB_DIMENSION_BASE::Update().

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 122 of file eda_item.h.

References EDA_ITEM::ClearFlags(), and SELECTED.

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

◆ ClearTempFlags()

virtual void EDA_ITEM::ClearTempFlags ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL.

Definition at line 153 of file eda_item.h.

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

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

◆ Clone()

EDA_ITEM * PCB_DIM_RADIAL::Clone ( ) const

overridevirtual

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

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

Returns: A clone of the item.

Reimplemented from EDA_ITEM.

Definition at line 1511 of file pcb_dimension.cpp.

◆ Compare()

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

inherited

Definition at line 1189 of file eda_text.cpp.

References TEXT_ATTRIBUTES::Compare(), EDA_TEXT::GetFontName(), EDA_TEXT::m_attributes, EDA_TEXT::m_pos, EDA_TEXT::m_text, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_TEXT::operator<(), EDA_TEXT::operator==(), and EDA_TEXT::operator>().

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

Definition at line 276 of file eda_text.cpp.

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

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 209 of file board_item.cpp.

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

◆ Deserialize()

bool PCB_DIM_RADIAL::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_DIMENSION_BASE.

Definition at line 1488 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::Deserialize(), PCB_DIMENSION_BASE::SetEnd(), SetLeaderLength(), PCB_DIMENSION_BASE::SetStart(), and PCB_DIMENSION_BASE::Update().

◆ drawAnArrow()

void PCB_DIMENSION_BASE::drawAnArrow	(	VECTOR2I	aStartPoint,
		EDA_ANGLE	anAngle,
		int	aLength
	)

protectedinherited

Draws an arrow and updates the shape container.

example arrow 0Deg tail:4 (-—>)

Parameters

startPoint	arrow point.
anAngle	arrow angle.
aLength	arrow tail length.

Definition at line 337 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_arrowLength, PCB_DIMENSION_BASE::m_shapes, RotatePoint(), and s_arrowAngle.

Referenced by PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), updateGeometry(), and PCB_DIM_LEADER::updateGeometry().

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 243 of file board_item.cpp.

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

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

◆ Empty()

void EDA_TEXT::Empty ( )

inherited

Definition at line 588 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_bounding_box_cache_valid, and EDA_TEXT::m_text.

Referenced by SCH_IO_KICAD_LEGACY_LIB_CACHE::LoadPart().

◆ Flip()

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

overridevirtualinherited

Flip this object, i.e.

change the board side for this object.

Parameters

aCentre	the rotation point.
aFlipDirection	the flip direction

Reimplemented from BOARD_ITEM.

Definition at line 557 of file pcb_dimension.cpp.

References FlipLayer(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayer(), PCB_DIMENSION_BASE::Mirror(), and BOARD_ITEM::SetLayer().

◆ FlipHJustify()

void EDA_TEXT::FlipHJustify ( )

inlineinherited

Definition at line 195 of file eda_text.h.

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

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

◆ 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 1038 of file eda_text.cpp.

References CTL_OMIT_COLOR, CTL_OMIT_HIDE, CTL_OMIT_HYPERLINK, KICAD_FORMAT::FormatBool(), FormatDouble2Str(), EDA_UNIT_UTILS::FormatInternalUnits(), EDA_TEXT::GetFont(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetHyperlink(), EDA_TEXT::GetLineSpacing(), EDA_TEXT::GetTextColor(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, EDA_TEXT::HasHyperlink(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsVisible(), KiROUND(), EDA_TEXT::m_IuScale, OUTPUTFORMATTER::Print(), and OUTPUTFORMATTER::Quotew().

Referenced by SCH_IO_KICAD_SEXPR::saveField(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField().

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 119 of file inspectable.h.

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

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 99 of file inspectable.h.

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

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), PROPERTIES_PANEL::getItemValue(), PCBEXPR_VAR_REF::GetValue(), and SCHEMATIC::SCHEMATIC().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 107 of file inspectable.h.

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

◆ GetArrowDirection()

DIM_ARROW_DIRECTION PCB_DIMENSION_BASE::GetArrowDirection ( ) const

inlineinherited

Definition at line 200 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_arrowDirection.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), DRAWING_TOOL::DrawDimension(), PCB_IO_KICAD_SEXPR::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetArrowLength()

int PCB_DIMENSION_BASE::GetArrowLength ( ) const

inlineinherited

Definition at line 264 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_arrowLength.

Referenced by DRAWING_TOOL::DrawDimension(), PCB_IO_KICAD_SEXPR::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetAttributes()

const TEXT_ATTRIBUTES & EDA_TEXT::GetAttributes ( ) const

inlineinherited

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 61 of file board_item.cpp.

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

◆ GetBoard() [2/2]

const BOARD * BOARD_ITEM::GetBoard ( ) const

virtualinherited

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

Definition at line 47 of file board_item.cpp.

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

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

◆ GetBoundingBox()

const BOX2I PCB_DIMENSION_BASE::GetBoundingBox ( ) const

overridevirtualinherited

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

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_DIM_CENTER.

Definition at line 714 of file pcb_dimension.cpp.

References BOX2< Vec >::GetBottom(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetRight(), PCB_DIMENSION_BASE::GetShapes(), EDA_TEXT::GetTextBox(), BOX2< Vec >::GetX(), BOX2< Vec >::GetY(), BOX2< Vec >::Inflate(), PCB_DIMENSION_BASE::m_lineThickness, BOX2< Vec >::Normalize(), BOX2< Vec >::SetHeight(), BOX2< Vec >::SetWidth(), BOX2< Vec >::SetX(), BOX2< Vec >::SetY(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_DIMENSION_BASE::HitTest(), and PCB_DIMENSION_BASE::ViewBBox().

◆ GetCenter()

virtual VECTOR2I BOARD_ITEM::GetCenter ( ) const

inlinevirtualinherited

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

Returns: center point of the item

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

Definition at line 111 of file board_item.h.

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

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

◆ GetClass()

wxString PCB_DIM_RADIAL::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 611 of file pcb_dimension.h.

◆ getDrawFont()

KIFONT::FONT * EDA_TEXT::getDrawFont ( ) const

protectedvirtualinherited

Reimplemented in SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 614 of file eda_text.cpp.

References EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), EDA_TEXT::IsBold(), and EDA_TEXT::IsItalic().

Referenced by EDA_TEXT::GetEffectiveTextShape(), EDA_TEXT::GetInterline(), PCB_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), PCB_TEXT::TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ GetDrawPos()

virtual VECTOR2I EDA_TEXT::GetDrawPos ( ) const

inlinevirtualinherited

Reimplemented in SCH_TEXTBOX, and PCB_TEXTBOX.

Definition at line 363 of file eda_text.h.

References EDA_TEXT::GetTextPos().

Referenced by BOARD_ADAPTER::addText(), PCB_TEXT::buildBoundingHull(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT::GetEffectiveTextShape(), EDA_TEXT::GetLinePositions(), EDA_TEXT::GetRenderCache(), EDA_TEXT::GetTextBox(), EDA_TEXT::Print(), and EDA_TEXT::TextHitTest().

◆ GetDrawRotation()

EDA_ANGLE PCB_TEXT::GetDrawRotation ( ) const

overridevirtualinherited

Returns: the text rotation for drawings and plotting the footprint rotation is taken in account.

Reimplemented from EDA_TEXT.

Definition at line 175 of file pcb_text.cpp.

References ANGLE_180, ANGLE_90, BOARD_ITEM::GetParentFootprint(), EDA_TEXT::GetTextAngle(), EDA_TEXT::IsKeepUpright(), and EDA_ANGLE::Normalize().

Referenced by PCB_TEXT::buildBoundingHull(), KIGFX::PCB_PAINTER::draw(), PCB_TEXT::GetBoundingBox(), CLIPBOARD_IO::SaveSelection(), and PCB_TEXT::TransformTextToPolySet().

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 133 of file eda_item.h.

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

◆ GetEffectiveHoleShape()

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

virtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 288 of file board_item.cpp.

References EDA_ITEM::GetClass(), and UNIMPLEMENTED_FOR.

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

◆ GetEffectiveShape()

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

overridevirtualinherited

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

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

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

Parameters

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

Reimplemented from PCB_TEXT.

Definition at line 665 of file pcb_dimension.cpp.

References PCB_TEXT::Clone(), EDA_TEXT::GetEffectiveTextShape(), and PCB_DIMENSION_BASE::GetShapes().

◆ GetEffectiveTextPenWidth()

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

inherited

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

Definition at line 456 of file eda_text.cpp.

References Clamp_Text_PenSize(), GetPenSizeForBold(), GetPenSizeForNormal(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), and EDA_TEXT::IsBold().

Referenced by BOARD_ADAPTER::addText(), PCB_IO_IPC2581::addText(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_LABEL_BASE::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), EDA_TEXT::GetEffectiveTextShape(), SCH_FIELD::GetPenWidth(), SCH_DIRECTIVE_LABEL::GetPenWidth(), SCH_TEXT::GetPenWidth(), EDA_TEXT::GetTextBox(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotText(), SCH_FIELD::Print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), PCB_TEXT::TransformTextToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), updateGeometry(), PCB_DIM_LEADER::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 1110 of file eda_text.cpp.

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

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

◆ GetEmbeddedFiles()

virtual EMBEDDED_FILES * EDA_ITEM::GetEmbeddedFiles ( )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, SCHEMATIC, BOARD, and FOOTPRINT.

Definition at line 444 of file eda_item.h.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::Parse().

◆ GetEnd()

virtual const VECTOR2I & PCB_DIMENSION_BASE::GetEnd ( ) const

inlinevirtualinherited

Definition at line 134 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_end.

◆ GetExtensionOffset()

int PCB_DIMENSION_BASE::GetExtensionOffset ( ) const

inlineinherited

Definition at line 268 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_extensionOffset.

Referenced by PCB_IO_KICAD_SEXPR::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 130 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), SCH_TABLE::DeleteMarkedCells(), PCB_TABLE::DeleteMarkedCells(), doConvertOutlineToPolygon(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::EditPush(), PCB_TUNING_PATTERN::EditRevert(), enclosedByAreaFunc(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), LIB_SYMBOL::LIB_SYMBOL(), EE_SELECTION_TOOL::Main(), BOARD_INSPECTION_TOOL::makeDRCEngine(), CONVERT_TOOL::makePolysFromChainedSegs(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_SYMBOL_PROPERTIES::OnUnitChoice(), LIB_SYMBOL::operator=(), BOARD_COMMIT::Push(), PAD::Recombine(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_IO_KICAD_SEXPR::saveTable(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and PCB_TUNING_PATTERN::Update().

◆ GetFocusPosition()

virtual const VECTOR2I EDA_ITEM::GetFocusPosition ( ) const

inlinevirtualinherited

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

Reimplemented in BOARD, PCB_SHAPE, PCB_TRACK, and PCB_ARC.

Definition at line 250 of file eda_item.h.

References EDA_ITEM::GetPosition().

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

◆ GetFont()

KIFONT::FONT * EDA_TEXT::GetFont ( ) const

inlineinherited

Definition at line 234 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Font.

Referenced by BOARD_ADAPTER::addText(), PCB_IO_IPC2581::addText(), SCH_EDIT_TOOL::ChangeTextType(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), PCB_IO_KICAD_SEXPR::format(), EDA_TEXT::Format(), PCB_IO_KICAD_SEXPR::formatRenderCache(), EDA_TEXT::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), KIGFX::SCH_PAINTER::getFont(), EDA_TEXT::GetFontIndex(), EDA_TEXT::GetFontName(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetRenderCache(), FIELDS_GRID_TABLE::GetValue(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotText(), SCH_FIELD::Print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), EDA_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), EDA_TEXT::SetBold(), EDA_TEXT::SetItalic(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetFontIndex()

int EDA_TEXT::GetFontIndex ( ) const

inherited

Definition at line 979 of file eda_text.cpp.

References Fontconfig(), EDA_TEXT::GetFont(), KIFONT::FONT::GetName(), KICAD_FONT_NAME, and Pgm().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ GetFontMetrics()

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

inherited

Definition at line 100 of file board_item.cpp.

References KIFONT::METRICS::Default().

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

◆ getFontMetrics()

const KIFONT::METRICS & PCB_TEXT::getFontMetrics ( ) const

inlineoverrideprotectedvirtualinherited

Reimplemented from EDA_TEXT.

Definition at line 188 of file pcb_text.h.

References BOARD_ITEM::GetFontMetrics().

◆ GetFontName()

wxString EDA_TEXT::GetFontName ( ) const

inherited

Definition at line 970 of file eda_text.cpp.

References EDA_TEXT::GetFont(), and KIFONT::FONT::GetName().

Referenced by EDA_TEXT::Compare(), and EDA_TEXT::IsDefaultFormatting().

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 158 of file view_item.h.

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

◆ GetFPRelativePosition()

VECTOR2I BOARD_ITEM::GetFPRelativePosition ( ) const

inherited

Definition at line 327 of file board_item.cpp.

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

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

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in SCH_FIELD, SCH_LINE, SCH_PIN, SCH_RULE_AREA, SCH_TEXT, PCB_TUNING_PATTERN, PCB_SHAPE, PCB_TABLECELL, PCB_TEXTBOX, PCB_TRACK, and ZONE.

Definition at line 332 of file eda_item.cpp.

References EDA_ITEM::GetTypeDesc().

Referenced by API_HANDLER_PCB::createItemForType(), API_HANDLER_SCH::createItemForType(), DIALOG_SHAPE_PROPERTIES::DIALOG_SHAPE_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), SCH_ITEM::getSymbolEditorMsgPanelInfo(), PROPERTIES_PANEL::rebuildProperties(), and DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow().

◆ GetHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::GetHorizJustify ( ) const

inlineinherited

Definition at line 187 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Halign.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), SCH_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), AUTOPLACER::fieldHPlacement(), EDA_TEXT::FlipHJustify(), EDA_TEXT::Format(), SCH_TEXTBOX::GetDrawPos(), PCB_TEXTBOX::GetDrawPos(), SCH_FIELD::GetEffectiveHorizJustify(), SCH_FIELD::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_LABEL_BASE::GetSpinStyle(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::IsHorizJustifyFlipped(), AUTOPLACER::justifyField(), PCB_TEXT::KeepUpright(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SIM_MODEL::MigrateSimModel(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_TEXT::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), SCH_TEXT::NormalizeJustification(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_FIELD::Plot(), positioningChanged(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), processTextItem(), SCH_FIELD::Rotate(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), EDA_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), swapFieldPositionsWithMatching(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIM_ALIGNED_TEXT_UPDATER::UpdateTextAfterChange().

◆ GetHyperlink()

wxString EDA_TEXT::GetHyperlink ( ) const

inlineinherited

Definition at line 384 of file eda_text.h.

References EDA_TEXT::m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), CLIPBOARD_IO::SaveSelection(), EDA_TEXT::Serialize(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetInterline()

int EDA_TEXT::GetInterline ( ) 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 697 of file eda_text.cpp.

References EDA_TEXT::getDrawFont(), EDA_TEXT::getFontMetrics(), EDA_TEXT::GetInterline(), EDA_TEXT::GetTextHeight(), and KiROUND().

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), EDA_TEXT::GetInterline(), and EDA_TEXT::GetLinePositions().

◆ GetItemDescription()

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

overridevirtualinherited

Return a user-visible description string of this item.

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

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

Parameters

aLong indicates a long string is acceptable

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 747 of file pcb_dimension.cpp.

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

◆ GetKeepTextAligned()

bool PCB_DIMENSION_BASE::GetKeepTextAligned ( ) const

inlineinherited

Definition at line 254 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_keepTextAligned.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), PCB_IO_KICAD_SEXPR::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetKnee()

VECTOR2I PCB_DIM_RADIAL::GetKnee ( ) const

Definition at line 1536 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_end, m_leaderLength, PCB_DIMENSION_BASE::m_start, and VECTOR2< T >::Resize().

Referenced by PCB_GRID_HELPER::computeAnchors(), DRAWING_TOOL::DrawDimension(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::MakePoints(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::UpdatePoints(), and updateText().

◆ getKnockoutMargin()

int PCB_TEXT::getKnockoutMargin ( ) const

protectedinherited

Definition at line 299 of file pcb_text.cpp.

References GetKnockoutTextMargin(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextThickness(), and EDA_TEXT::GetTextWidth().

Referenced by PCB_TEXT::GetBoundingBox().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in FOOTPRINT, PAD, PCB_SHAPE, PCB_VIA, and ZONE.

Definition at line 237 of file board_item.h.

References BOARD_ITEM::m_layer.

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

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

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

Returns: the layer name associated with this item.

Definition at line 139 of file board_item.cpp.

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

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

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

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

Definition at line 257 of file board_item.h.

References BOARD_ITEM::m_layer, and UNDEFINED_LAYER.

Referenced by SCOPED_LAYERSET::Add(), PCB_GRID_HELPER::BestSnapAnchor(), BOARD_ITEM::BoardLayerCount(), BOARD_ITEM::BoardLayerSet(), collidesWithArea(), PCB_GRID_HELPER::computeAnchors(), BOARD_COMMIT::dirtyIntersectingZones(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRules(), existsOnLayerFunc(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), hash_board_item(), BOARD_INSPECTION_TOOL::InspectClearance(), intersectsAreaFunc(), PNS_KICAD_IFACE::IsItemVisible(), isMaskAperture(), BOARD_ITEM::IsSideSpecific(), BOARD_ITEM::layerMaskDescribe(), FABMASTER::loadZone(), PCB_POINT_EDITOR::OnSelectionChange(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), CN_VISITOR::operator()(), BOARD_ITEM::ptr_cmp::operator()(), KI_TEST::kitest_cmp_drawings::operator()(), DRC_ENGINE::ProcessAssertions(), EDIT_TOOL::Properties(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), SCOPED_LAYERSET::SCOPED_LAYERSET(), GLOBAL_EDIT_TOOL::swapBoardItem(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), and PCB_CONTROL::UpdateMessagePanel().

◆ GetLeaderLength()

int PCB_DIM_RADIAL::GetLeaderLength ( ) const

inline

Definition at line 598 of file pcb_dimension.h.

References m_leaderLength.

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

◆ GetLinePositions()

void EDA_TEXT::GetLinePositions	(	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 880 of file eda_text.cpp.

References EDA_TEXT::GetDrawPos(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetInterline(), EDA_TEXT::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 SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotText(), and EDA_TEXT::Print().

◆ GetLineSpacing()

double EDA_TEXT::GetLineSpacing ( ) const

inlineinherited

Definition at line 242 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_LineSpacing.

Referenced by EDA_TEXT::Format(), EDA_TEXT::Serialize(), and PCB_TEXTBOX::Serialize().

◆ GetLineThickness()

int PCB_DIMENSION_BASE::GetLineThickness ( ) const

inlineinherited

Definition at line 270 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_lineThickness.

Referenced by BOARD_ADAPTER::addShape(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawDimension(), PCB_IO_KICAD_SEXPR::format(), BRDITEMS_PLOTTER::PlotDimension(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetMeasuredValue()

int PCB_DIMENSION_BASE::GetMeasuredValue ( ) const

inlineinherited

Definition at line 153 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_measuredValue.

Referenced by PCB_DIMENSION_BASE::GetValueText().

◆ GetMenuImage()

BITMAPS PCB_DIM_RADIAL::GetMenuImage ( ) const

overridevirtual

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

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

Returns: The menu image associated with the item.

Reimplemented from EDA_ITEM.

Definition at line 1530 of file pcb_dimension.cpp.

◆ GetMsgPanelInfo()

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

overridevirtualinherited

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

Parameters

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

Reimplemented from EDA_ITEM.

Reimplemented in PCB_DIM_ALIGNED, and PCB_DIM_LEADER.

Definition at line 586 of file pcb_dimension.cpp.

Referenced by PCB_DIM_ALIGNED::GetMsgPanelInfo().

◆ GetOverrideText()

wxString PCB_DIMENSION_BASE::GetOverrideText ( ) const

inlineinherited

Definition at line 143 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_valueString.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), PCB_IO_KICAD_SEXPR::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetOverrideTextEnabled()

bool PCB_DIMENSION_BASE::GetOverrideTextEnabled ( ) const

inlineinherited

Definition at line 140 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_overrideTextEnabled.

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( ) const

inlineinherited

Definition at line 215 of file board_item.h.

References EDA_ITEM::m_parent.

Referenced by ALIGN_DISTRIBUTE_TOOL::AlignBottom(), ALIGN_DISTRIBUTE_TOOL::AlignCenterX(), ALIGN_DISTRIBUTE_TOOL::AlignCenterY(), ALIGN_DISTRIBUTE_TOOL::AlignTop(), PCB_EDIT_TABLE_TOOL::copyCell(), FOOTPRINT::CoverageRatio(), BOARD_ADAPTER::createTrackWithMargin(), BOARD_ITEM::DeleteStructure(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), ALIGN_DISTRIBUTE_TOOL::doAlignLeft(), ALIGN_DISTRIBUTE_TOOL::doAlignRight(), EDIT_TOOL::DragArcTrack(), KIGFX::PCB_PAINTER::draw(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForTableCells(), BOARD_ITEM::GetBoard(), getClosestGroup(), PCB_TABLECELL::GetColumn(), BOARD_ITEM::GetParentFootprint(), PCB_TABLECELL::GetRow(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), memberOfGroupFunc(), EDIT_TOOL::MoveExact(), PAD::operator==(), PAD::PAD(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_SELECTION_TOOL::pruneObscuredSelectionCandidates(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), PAD::Similarity(), BOARD_ITEM::SwapItemData(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testPadAgainstItem(), KIGFX::PCB_VIEW::Update(), PCB_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), PAD_POINT_EDIT_BEHAVIOR::UpdatePoints(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem().

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

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

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC().

◆ GetParentFootprint()

FOOTPRINT * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 298 of file board_item.cpp.

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), PCB_IO_IPC2581::addPad(), FEATURES_MANAGER::AddPadShape(), STEP_PCB_MODEL::AddPadShape(), PCB_IO_IPC2581::addPadStack(), GRAPHICS_IMPORTER_PCBNEW::AddPolygon(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), DIALOG_TRACK_VIA_PROPERTIES::confirmPadChange(), EDIT_TOOL::DeleteItems(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TEXTBOX_PROPERTIES::DIALOG_TEXTBOX_PROPERTIES(), doPushPadProperties(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), EDIT_TOOL::Duplicate(), DRC_ENGINE::EvalRules(), PCB_IO_KICAD_SEXPR::format(), FormatProbeItem(), PCB_IO_IPC2581::generateLayerSetNet(), PAD::GetClearanceOverrides(), PCB_BASE_EDIT_FRAME::GetContextualTextVars(), PCB_TEXT::GetDrawRotation(), PAD::GetFPRelativeOrientation(), BOARD_ITEM::GetFPRelativePosition(), PAD::GetItemDescription(), PCB_FIELD::GetItemDescription(), PCB_SHAPE::GetItemDescription(), PCB_TEXT::GetItemDescription(), PCB_SHAPE::GetMenuImage(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), PAD::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), PCB_FIELDS_GRID_TABLE::GetValue(), PAD::GetZoneConnectionOverrides(), PCB_SELECTION_TOOL::grabUnconnected(), GROUP_TOOL::Group(), hash_fp_item(), PAD::ImportSettingsFrom(), DIALOG_PAD_PROPERTIES::initValues(), GENERAL_COLLECTOR::Inspect(), PCB_SHAPE::IsConnected(), PAD::IsFlipped(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), PNS_PCBNEW_RULE_RESOLVER::IsKeepout(), PNS_PCBNEW_RULE_RESOLVER::IsNetTieExclusion(), DRC_ENGINE::IsNetTieExclusion(), PCB_SELECTION_TOOL::itemPassesFilter(), memberOfFootprintFunc(), memberOfSheetFunc(), BOARD::Move(), ARRAY_TOOL::onDialogClosed(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_SHAPE(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), 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::Recombine(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), BOARD_COMMIT::Revert(), PAD::SameLogicalPadAs(), CLIPBOARD_IO::SaveSelection(), PCB_SELECTION_TOOL::Selectable(), PAD::SetFPRelativeOrientation(), BOARD_ITEM::SetFPRelativePosition(), PCB_FIELDS_GRID_TABLE::SetValue(), PAD::SharesNetTieGroup(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::transferDataToPad(), PCB_IO_EAGLE::transferPad(), PCB_POINT_EDITOR::updateItem(), PCB_FIELD::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), ZONE::ViewGetLOD(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), and ZONE::ZONE().

◆ GetParentGroup()

PCB_GROUP * BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 90 of file board_item.h.

References BOARD_ITEM::m_group.

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

◆ GetPosition()

VECTOR2I PCB_DIMENSION_BASE::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from PCB_TEXT.

Definition at line 137 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_start.

Referenced by PCB_DIMENSION_BASE::ViewBBox(), and PCB_DIM_CENTER::ViewBBox().

◆ GetPrecision()

DIM_PRECISION PCB_DIMENSION_BASE::GetPrecision ( ) const

inlineinherited

Definition at line 236 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_precision.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), PCB_IO_KICAD_SEXPR::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetPrefix()

wxString PCB_DIMENSION_BASE::GetPrefix ( ) const

inlineinherited

Definition at line 182 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_prefix.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), PCB_IO_KICAD_SEXPR::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetRenderCache()

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

inherited

Definition at line 644 of file eda_text.cpp.

References EDA_TEXT::GetAttributes(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::getFontMetrics(), KIFONT::OUTLINE_FONT::GetLinesAsGlyphs(), KIFONT::FONT::IsOutline(), TEXT_ATTRIBUTES::m_Angle, EDA_TEXT::m_render_cache, EDA_TEXT::m_render_cache_angle, EDA_TEXT::m_render_cache_font, EDA_TEXT::m_render_cache_offset, and EDA_TEXT::m_render_cache_text.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_IO_KICAD_SEXPR::formatRenderCache(), and EDA_TEXT::GetEffectiveTextShape().

◆ GetShapes()

const std::vector< std::shared_ptr< SHAPE > > & PCB_DIMENSION_BASE::GetShapes ( ) const

inlineinherited

Returns: a list of line segments that make up this dimension (for drawing, plotting, etc).

Definition at line 276 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_shapes.

Referenced by BOARD_ADAPTER::addShape(), KIGFX::PCB_PAINTER::draw(), PCB_DIMENSION_BASE::GetBoundingBox(), PCB_DIMENSION_BASE::GetEffectiveShape(), PCB_DIMENSION_BASE::HitTest(), and BRDITEMS_PLOTTER::PlotDimension().

◆ GetShownText()

wxString PCB_TEXT::GetShownText	(	bool	aAllowExtraText,
		int	aDepth = `0`
	)		const

overridevirtualinherited

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

Parameters

aAllowExtraText	is true to allow adding more text than the initial expanded text, for intance a title, a prefix for texts in display functions. False to disable any added text (for instance when writing the shown text in netlists).
aDepth	is used to prevent infinite recursions and loops when expanding text variables.

Reimplemented from EDA_TEXT.

Definition at line 133 of file pcb_text.cpp.

References ExpandTextVars(), BOARD_ITEM::GetBoard(), ADVANCED_CFG::GetCfg(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetParentFootprint(), EDA_TEXT::GetShownText(), EDA_TEXT::HasTextVars(), resolver, BOARD::ResolveTextVar(), FOOTPRINT::ResolveTextVar(), and text.

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_IO_IPC2581::generateAvlSection(), PCB_IO_IPC2581::generateComponents(), PCB_DIMENSION_BASE::GetItemDescription(), PCB_FIELD::GetItemDescription(), PCB_TEXT::GetItemDescription(), idf_export_footprint(), FOOTPRINT::ResolveTextVar(), PCB_TEXT::TransformTextToPolySet(), and DIALOG_DIMENSION_PROPERTIES::updatePreviewText().

◆ GetSortPosition()

virtual VECTOR2I EDA_ITEM::GetSortPosition ( ) const

inlinevirtualinherited

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

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

Returns: X,Y coordinate of the sort point

Reimplemented in SCH_LINE.

Definition at line 259 of file eda_item.h.

References EDA_ITEM::GetPosition().

◆ GetStart()

virtual const VECTOR2I & PCB_DIMENSION_BASE::GetStart ( ) const

inlinevirtualinherited

The dimension's origin is the first feature point for the dimension.

Every dimension has one or more feature points, so every dimension has at least an origin.

Returns: the origin point of this dimension

Definition at line 131 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_start.

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 86 of file board_item.cpp.

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

Referenced by CONVERT_TOOL::CreatePolys().

◆ GetSuffix()

wxString PCB_DIMENSION_BASE::GetSuffix ( ) const

inlineinherited

Definition at line 191 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_suffix.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), PCB_IO_KICAD_SEXPR::format(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetSuppressZeroes()

bool PCB_DIMENSION_BASE::GetSuppressZeroes ( ) const

inlineinherited

Definition at line 245 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_suppressZeroes.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), PCB_IO_KICAD_SEXPR::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetTempFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetTempFlags ( ) const

inlineinherited

Definition at line 146 of file eda_item.h.

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

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

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

Definition at line 98 of file eda_text.h.

References EDA_TEXT::m_text.

◆ GetTextAngle()

const EDA_ANGLE & EDA_TEXT::GetTextAngle ( ) const

inlineinherited

Definition at line 134 of file eda_text.h.

References TEXT_ATTRIBUTES::m_Angle, and EDA_TEXT::m_attributes.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), SCH_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_IO_KICAD_SEXPR::format(), SCH_LABEL::GetBodyBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), SCH_TEXTBOX::GetDrawPos(), EDA_TEXT::GetDrawRotation(), SCH_FIELD::GetDrawRotation(), PCB_TEXT::GetDrawRotation(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_LABEL_BASE::GetSpinStyle(), FIELDS_GRID_TABLE::GetValue(), PCB_FIELDS_GRID_TABLE::GetValue(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), SCH_EDIT_TOOL::JustifyText(), PCB_TEXT::KeepUpright(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_TEXT::Mirror(), PCB_TEXTBOX::Mirror(), PCB_DIMENSION_BASE::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), SCH_TEXT::MirrorSpinStyle(), SCH_TEXT::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), SCH_TABLE::Normalize(), PCB_TABLE::Normalize(), SCH_TEXT::NormalizeJustification(), KI_TEST::kitest_cmp_drawings::operator()(), PCB_IO_EAGLE::orientFPText(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), positioningChanged(), SCH_FIELD::Print(), SCH_TEXT::Print(), processTextItem(), SCH_EDIT_TOOL::Rotate(), SCH_FIELD::Rotate(), SCH_TEXTBOX::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TABLE::Rotate(), PCB_TEXT::Rotate(), PCB_TEXTBOX::Rotate(), SCH_TEXT::Rotate90(), SCH_TEXTBOX::Rotate90(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR::saveText(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveText(), SCH_IO_KICAD_SEXPR::saveTextBox(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox(), PCB_TEXTBOX::SetTextAngle(), swapFieldPositionsWithMatching(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), EASYEDA_PARSER_BASE::TransformTextToBaseline(), DIALOG_FIELD_PROPERTIES::UpdateField(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), updateGeometry(), PCB_DIM_LEADER::updateGeometry(), SCH_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem(), and PCB_TABLECELL_POINT_EDIT_BEHAVIOR::UpdateItem().

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const

inlineinherited

Definition at line 141 of file eda_text.h.

References EDA_ANGLE::AsDegrees(), TEXT_ATTRIBUTES::m_Angle, and EDA_TEXT::m_attributes.

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

◆ GetTextAngleDegreesProp()

double PCB_DIMENSION_BASE::GetTextAngleDegreesProp ( ) const

inlineinherited

Definition at line 257 of file pcb_dimension.h.

References EDA_TEXT::GetTextAngleDegrees().

Referenced by DIMENSION_DESC::DIMENSION_DESC().

◆ GetTextBox()

BOX2I EDA_TEXT::GetTextBox ( 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 703 of file eda_text.cpp.

References EDA_TEXT::getDrawFont(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::getFontMetrics(), BOX2< Vec >::GetHeight(), EDA_TEXT::GetHorizJustify(), KIFONT::FONT::GetInterline(), EDA_TEXT::GetShownText(), EDA_TEXT::GetTextSize(), EDA_TEXT::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, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), KIFONT::FONT::IsStroke(), ITALIC_TILT, KiROUND(), EDA_TEXT::m_bounding_box_cache, EDA_TEXT::m_bounding_box_cache_line, EDA_TEXT::m_bounding_box_cache_pos, EDA_TEXT::m_bounding_box_cache_valid, 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 SCH_GLOBALLABEL::CreateGraphicShape(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), DS_DRAW_ITEM_TEXT::GetBoundingBox(), PCB_DIMENSION_BASE::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), SCH_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), SCH_TEXT::Print(), EDA_TEXT::TextHitTest(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), updateGeometry(), and PCB_DIM_LEADER::updateGeometry().

◆ GetTextColor()

COLOR4D EDA_TEXT::GetTextColor ( ) const

inlineinherited

◆ GetTextHeight()

int EDA_TEXT::GetTextHeight ( ) const

inlineinherited

Definition at line 251 of file eda_text.h.

References EDA_TEXT::m_attributes, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::y.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), SCH_FIELD::compare(), SCH_TEXT::compare(), SCH_TEXTBOX::compare(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_HIERLABEL::GetBodyBoundingBox(), EDA_TEXT::GetInterline(), PCB_TEXT::getKnockoutMargin(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_GLOBALLABEL::GetSchematicTextOffset(), FIELDS_GRID_TABLE::GetValue(), PCB_FIELDS_GRID_TABLE::GetValue(), hash_fp_item(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_IO_KICAD_SEXPR::saveField(), SCH_IO_LTSPICE_PARSER::setTextJustification(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_ORTHOGONAL::updateText(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ GetTextPos()

const VECTOR2I & EDA_TEXT::GetTextPos ( ) const

inlineinherited

Definition at line 257 of file eda_text.h.

References EDA_TEXT::m_pos.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), SCH_FIELD::compare(), SCH_TEXT::compare(), PCB_GRID_HELPER::computeAnchors(), SCH_SHEET_PIN::ConstrainOnEdge(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_LABEL::doIsConnected(), SCH_GLOBALLABEL::doIsConnected(), SCH_HIERLABEL::doIsConnected(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), PCB_TEXT::Flip(), PCB_IO_KICAD_SEXPR::format(), DS_DRAW_ITEM_TEXT::GetApproxBBox(), SCH_LABEL_BASE::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LABEL_BASE::GetConnectionPoints(), EDA_TEXT::GetDrawPos(), SCH_LABEL_BASE::GetEndPoints(), SCH_SHEET_PIN::GetEndPoints(), SCH_FIELD::GetLibPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetPosition(), DS_DRAW_ITEM_TEXT::GetPosition(), PCB_TEXT::GetPosition(), FIELDS_GRID_TABLE::GetValue(), ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::MakePoints(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::MakePoints(), DIM_LEADER_POINT_EDIT_BEHAVIOR::MakePoints(), PCB_TEXT::Mirror(), PCB_DIMENSION_BASE::Mirror(), SCH_FIELD::MirrorHorizontally(), SCH_DIRECTIVE_LABEL::MirrorHorizontally(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), SCH_FIELD::MirrorVertically(), SCH_DIRECTIVE_LABEL::MirrorVertically(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), SCH_TEXT::NormalizeJustification(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), std::hash< EDA_TEXT >::operator()(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotText(), SCH_FIELD::Print(), SCH_LABEL_BASE::Print(), DIALOG_CHANGE_SYMBOLS::processSymbols(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), EDA_TEXT::Serialize(), SCH_LABEL_BASE::SetPosition(), FIELDS_GRID_TABLE::SetValue(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), EASYEDA_PARSER_BASE::TransformTextToBaseline(), PCB_TEXT::TransformTextToPolySet(), SCH_LABEL_BASE::UpdateDanglingState(), updateGeometry(), PCB_DIM_LEADER::updateGeometry(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_LEADER_POINT_EDIT_BEHAVIOR::UpdateItem(), ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::UpdatePoints(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::UpdatePoints(), DIM_LEADER_POINT_EDIT_BEHAVIOR::UpdatePoints(), and updateText().

◆ GetTextPositionMode()

DIM_TEXT_POSITION PCB_DIMENSION_BASE::GetTextPositionMode ( ) const

inlineinherited

Definition at line 262 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_textPosition.

Referenced by PCB_IO_KICAD_SEXPR::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetTextSize()

VECTOR2I EDA_TEXT::GetTextSize ( ) const

inlineinherited

Definition at line 245 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Size.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT::GetEffectiveTextPenWidth(), SCH_LABEL_BASE::GetLabelBoxExpansion(), SCH_TEXTBOX::GetLegacyTextMargin(), PCB_TEXTBOX::GetLegacyTextMargin(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), PCB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), SCH_TEXT::GetTextOffset(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_IO_EAGLE::orientFPText(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), SCH_FIELD::Print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), processTextItem(), SCH_IO_KICAD_LEGACY::saveSheet(), EDA_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TEXT::TextHitTest(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), EASYEDA_PARSER_BASE::TransformTextToBaseline(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ GetTextStyleName()

wxString EDA_TEXT::GetTextStyleName ( ) const

inherited

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

Definition at line 949 of file eda_text.cpp.

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

Referenced by SCH_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

int EDA_TEXT::GetTextThickness ( ) const

inlineinherited

Definition at line 126 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_StrokeWidth.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), PCB_IO_KICAD_SEXPR::formatRenderCache(), EDA_TEXT::GetEffectiveTextPenWidth(), PCB_TEXT::getKnockoutMargin(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), PCB_FIELDS_GRID_TABLE::GetValue(), EDA_TEXT::IsDefaultFormatting(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), processTextItem(), SCH_IO_KICAD_LEGACY::saveText(), EDA_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), PCB_TEXT::TextHitTest(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES::Validate(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

◆ GetTextTypeDescription()

wxString PCB_TEXT::GetTextTypeDescription ( ) const

virtualinherited

Reimplemented in PCB_FIELD.

Definition at line 426 of file pcb_text.cpp.

References _.

Referenced by PCB_TEXT::GetMsgPanelInfo().

◆ GetTextWidth()

int EDA_TEXT::GetTextWidth ( ) const

inlineinherited

Definition at line 248 of file eda_text.h.

References EDA_TEXT::m_attributes, TEXT_ATTRIBUTES::m_Size, and VECTOR2< T >::x.

Referenced by SCH_FIELD::compare(), SCH_TEXT::compare(), SCH_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), PCB_TEXT::getKnockoutMargin(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TABLECELL::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_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_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SCH_IO_KICAD_LEGACY::saveText(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), updateGeometry(), PCB_DIM_LEADER::updateGeometry(), DIALOG_FIELD_PROPERTIES::updateText(), and DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::Validate().

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

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

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

◆ GetUnits()

EDA_UNITS PCB_DIMENSION_BASE::GetUnits ( ) const

inlineinherited

Definition at line 213 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_units.

Referenced by PCB_DIMENSION_BASE::GetMsgPanelInfo(), and PCB_DIM_ALIGNED::GetMsgPanelInfo().

◆ GetUnitsFormat()

DIM_UNITS_FORMAT PCB_DIMENSION_BASE::GetUnitsFormat ( ) const

inlineinherited

Definition at line 227 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_unitsFormat.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), PCB_IO_KICAD_SEXPR::format(), and DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow().

◆ GetUnitsMode()

DIM_UNITS_MODE PCB_DIMENSION_BASE::GetUnitsMode ( ) const

inherited

Definition at line 465 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_autoUnits, and PCB_DIMENSION_BASE::m_units.

Referenced by DIMENSION_DESC::DIMENSION_DESC(), PCB_IO_KICAD_SEXPR::format(), PCB_DIMENSION_BASE::Serialize(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), PCB_DIMENSION_BASE::UpdateUnits(), and BOARD::UpdateUserUnits().

◆ GetValueText()

wxString PCB_DIMENSION_BASE::GetValueText ( ) const

inherited

Returns: the dimension value, rendered with precision / zero suppression but no units, etc

Definition at line 405 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::GetMeasuredValue(), PCB_DIMENSION_BASE::m_precision, PCB_DIMENSION_BASE::m_suppressZeroes, PCB_DIMENSION_BASE::m_units, pcbIUScale, text, and EDA_UNIT_UTILS::UI::ToUserUnit().

Referenced by DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIMENSION_BASE::Serialize(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and PCB_DIMENSION_BASE::updateText().

◆ GetVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::GetVertJustify ( ) const

inlineinherited

Definition at line 190 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Valign.

Referenced by SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_TEXTBOX::GetDrawPos(), SCH_FIELD::GetEffectiveVertJustify(), EDA_TEXT::GetLinePositions(), SCH_FIELD::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), hash_fp_item(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::IsVertJustifyFlipped(), PCB_TEXT::KeepUpright(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_IO_EAGLE::loadPlain(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), SCH_TEXT::NormalizeJustification(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_FIELD::Plot(), positioningChanged(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), processTextItem(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), EDA_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), swapFieldPositionsWithMatching(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 94 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(), ZONE_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), BOARD_ITEM::SetY(), and ZONE_DESC::ZONE_DESC().

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 100 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(), ZONE_SEARCH_HANDLER::getResultCell(), TEXT_SEARCH_HANDLER::getResultCell(), BOARD_ITEM::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.

Definition at line 1291 of file eda_text.cpp.

Referenced by SCH_LABEL_BASE::Plot(), and SCH_SHEET::Plot().

◆ HasDrilledHole()

virtual bool BOARD_ITEM::HasDrilledHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 160 of file board_item.h.

Referenced by DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::InspectClearance(), and PNS_PCBNEW_RULE_RESOLVER::IsDrilledHole().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 131 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), SCH_EDIT_TOOL::DoDelete(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), PCB_TUNING_PATTERN::Flip(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_SCREEN::MarkConnections(), PCB_TUNING_PATTERN::Mirror(), PCB_TUNING_PATTERN::Move(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), GERBVIEW_FRAME::RemapLayers(), SCH_EDIT_TOOL::Rotate(), PCB_TUNING_PATTERN::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), PCB_SELECTION_TOOL::selectAllConnectedShapes(), EE_SELECTION_TOOL::selectMultiple(), SCH_COMMIT::Stage(), and PCB_TUNING_PATTERN::ViewDraw().

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 155 of file board_item.h.

Referenced by DRAWING_TOOL::DrawVia(), DRC_RTREE::Insert(), BOARD_INSPECTION_TOOL::InspectClearance(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstItem(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testItemAgainstZones(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testSingleLayerItemAgainstItem(), and PCB_CONTROL::UpdateMessagePanel().

◆ HasHyperlink()

virtual bool EDA_TEXT::HasHyperlink ( ) const

inlinevirtualinherited

Definition at line 383 of file eda_text.h.

References EDA_TEXT::m_hyperlink.

Referenced by EDA_TEXT::Format(), SCH_TEXT::IsHypertext(), SCH_TEXTBOX::IsHypertext(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ HasLineStroke()

virtual bool BOARD_ITEM::HasLineStroke ( ) const

inlinevirtualinherited

Check if this item has line stoke properties.

See also: STROKE_PARAMS

Reimplemented in PCB_SHAPE.

Definition at line 227 of file board_item.h.

Referenced by CONVERT_TOOL::CreatePolys().

◆ HasTextVars()

bool EDA_TEXT::HasTextVars ( ) const

inlineinherited

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

Definition at line 117 of file eda_text.h.

References EDA_TEXT::m_shown_text_has_text_var_refs.

Referenced by SCH_LABEL_BASE::cacheShownText(), KIGFX::SCH_PAINTER::draw(), PCB_TEXT::GetShownText(), PCB_TEXTBOX::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_LABEL_BASE::HasCachedDriverName(), and SCH_LABEL_BASE::SCH_LABEL_BASE().

◆ HitTest() [1/2]

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

overridevirtualinherited

Test if aRect intersects this item.

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 697 of file pcb_dimension.cpp.

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

◆ HitTest() [2/2]

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

overridevirtualinherited

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 678 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::GetShapes(), PCB_DIMENSION_BASE::m_lineThickness, and PCB_TEXT::TextHitTest().

◆ IsBOARD_ITEM()

bool KIGFX::VIEW_ITEM::IsBOARD_ITEM ( ) const

inlineinherited

Definition at line 100 of file view_item.h.

Referenced by KIGFX::PCB_VIEW::Add(), PCB_BASE_EDIT_FRAME::ClearListAndDeleteItems(), CONVERT_TOOL::CreatePolys(), EDIT_TOOL::doMoveSelection(), KIGFX::PCB_PAINTER::Draw(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), GENERAL_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_COMMIT::MakeImage(), BOARD::Move(), DRAWING_TOOL::PlaceImportedGraphics(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), KIGFX::PCB_VIEW::Remove(), EDIT_TOOL::removeNonRootItems(), BOARD_COMMIT::Revert(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPlotSettings(), PCB_EDIT_FRAME::ShowBoardSetupDialog(), EDIT_TOOL::Swap(), PCB_SELECTION_TOOL::unhighlightInternal(), PCB_TEST_SELECTION_TOOL::unhighlightInternal(), KIGFX::PCB_VIEW::Update(), EDIT_TOOL::updateModificationPoint(), and DIALOG_POSITION_RELATIVE::UpdatePickedItem().

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const

inlineinherited

Definition at line 171 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Bold.

Referenced by BOARD_ADAPTER::addText(), SCH_EDIT_TOOL::ChangeTextType(), SCH_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), EDA_TEXT::GetEffectiveTextPenWidth(), KIGFX::SCH_PAINTER::getFont(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetRenderCache(), PCB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextStyleName(), FIELDS_GRID_TABLE::GetValue(), FIELDS_GRID_TABLE::GetValueAsBool(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotText(), SCH_FIELD::Print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), EDA_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), EDA_TEXT::SetFontIndex(), EDA_TEXT::SetItalic(), FIELDS_GRID_TABLE::SetValue(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 112 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ IsConnected()

virtual bool BOARD_ITEM::IsConnected ( ) const

inlinevirtualinherited

Returns information if the object is derived from BOARD_CONNECTED_ITEM.

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

Reimplemented in BOARD_CONNECTED_ITEM, PCB_SHAPE, and ZONE.

Definition at line 133 of file board_item.h.

Referenced by DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::expandConnection(), PNS::NODE::FindItemByParent(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), BOARD_INSPECTION_TOOL::getItemDescription(), hasNetclassFunc(), inDiffPairFunc(), BOARD_INSPECTION_TOOL::InspectClearance(), CONNECTIVITY_DATA::MarkItemNetAsDirty(), CN_CONNECTIVITY_ALGO::markItemNetAsDirty(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_COPPER_CLEARANCE::testItemAgainstZone(), and DRC_TEST_PROVIDER_SOLDER_MASK::testMaskItemAgainstZones().

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

inherited

Definition at line 1023 of file eda_text.cpp.

References EDA_TEXT::GetFontName(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetVertJustify(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), and EDA_TEXT::IsVisible().

Referenced by SCH_IO_KICAD_SEXPR::saveField().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 111 of file eda_item.h.

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 195 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

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

◆ 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 1285 of file eda_text.cpp.

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

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const

inlineinherited

Definition at line 156 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Italic.

Referenced by BOARD_ADAPTER::addText(), SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), SCH_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), KIGFX::SCH_PAINTER::getFont(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TABLECELL::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetRenderCache(), PCB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextStyleName(), FIELDS_GRID_TABLE::GetValue(), FIELDS_GRID_TABLE::GetValueAsBool(), PCB_FIELDS_GRID_TABLE::GetValueAsBool(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), BRDITEMS_PLOTTER::PlotText(), SCH_FIELD::Print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), SCH_IO_KICAD_LEGACY::saveText(), EDA_TEXT::Serialize(), PCB_TEXTBOX::Serialize(), EDA_TEXT::SetBold(), EDA_TEXT::SetFontIndex(), FIELDS_GRID_TABLE::SetValue(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ IsKeepUpright()

bool EDA_TEXT::IsKeepUpright ( ) const

inlineinherited

Definition at line 193 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_KeepUpright.

Referenced by PCB_IO_KICAD_SEXPR::format(), PCB_TEXT::GetDrawRotation(), PCB_FIELDS_GRID_TABLE::GetValueAsBool(), PCB_TEXT::KeepUpright(), PCB_TEXT_DESC::PCB_TEXT_DESC(), EDA_TEXT::Serialize(), and PCB_TEXTBOX::Serialize().

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Definition at line 324 of file board_item.h.

References BOARD_ITEM::m_isKnockout.

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

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

Reimplemented in FOOTPRINT, and PAD.

Definition at line 75 of file board_item.cpp.

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

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

◆ IsMirrored()

bool EDA_TEXT::IsMirrored ( ) const

inlineinherited

◆ IsModified()

bool EDA_ITEM::IsModified ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

References IS_MOVING, and EDA_ITEM::m_flags.

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

◆ IsMultilineAllowed()

bool EDA_TEXT::IsMultilineAllowed ( ) const

inlineinherited

Definition at line 184 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Multiline.

Referenced by EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), BRDITEMS_PLOTTER::PlotText(), EDA_TEXT::Print(), EDA_TEXT::Serialize(), and PCB_TEXTBOX::Serialize().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_TOOL::ChangeBodyStyle(), SCH_EDIT_TOOL::ChangeTextType(), EDIT_TOOL::doMoveSelection(), SYMBOL_EDITOR_MOVE_TOOL::doMoveSelection(), SCH_MOVE_TOOL::doMoveSelection(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), PCB_TUNING_PATTERN::EditStart(), EDIT_TOOL::Flip(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), SCH_SCREEN::IsTerminalPoint(), EE_POINT_EDITOR::Main(), PL_EDIT_TOOL::Main(), PL_POINT_EDITOR::Main(), EDIT_TOOL::MoveExact(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PROPERTIES::TransferDataFromWindow(), 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, and ZONE.

Definition at line 150 of file board_item.h.

References BOARD_ITEM::GetLayer(), and IsCopperLayer().

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

◆ IsOnLayer()

virtual bool BOARD_ITEM::IsOnLayer ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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 in FOOTPRINT, PAD, PCB_GROUP, PCB_SHAPE, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 319 of file board_item.h.

References BOARD_ITEM::m_layer.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), CreepageGraph::AddNetElements(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), CN_VISITOR::checkZoneItemConnection(), existsOnLayerFunc(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), isEdge(), PNS_KICAD_IFACE::IsItemVisible(), BOARD_COMMIT::Push(), ROUTER_PREVIEW_ITEM::ROUTER_PREVIEW_ITEM(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), DRC_TEST_PROVIDER_SOLDER_MASK::testMaskBridges(), and PCB_CONTROL::UpdateMessagePanel().

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

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 114 of file eda_item.h.

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSCH_ITEM()

bool KIGFX::VIEW_ITEM::IsSCH_ITEM ( ) const

inlineinherited

Definition at line 99 of file view_item.h.

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

References EDA_ITEM::m_flags, and SELECTED.

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

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 168 of file eda_item.h.

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsSideSpecific()

bool BOARD_ITEM::IsSideSpecific ( ) const

inherited

Definition at line 149 of file board_item.cpp.

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

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

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( PCB_LAYER_ID aLayer ) const

inlinevirtualinherited

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

Parameters

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

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

Reimplemented in PCB_VIA.

Definition at line 172 of file board_item.h.

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

◆ IsType()

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

inlineoverridevirtualinherited

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Reimplemented from EDA_ITEM.

Definition at line 54 of file pcb_text.h.

References EDA_ITEM::IsType(), and PCB_LOCATE_TEXT_T.

◆ IsVisible()

virtual bool EDA_TEXT::IsVisible ( ) const

inlinevirtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 174 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Visible.

Referenced by PCB_IO_IPC2581::addText(), SCH_EDITOR_CONTROL::AssignFootprints(), EDIT_TOOL::DeleteItems(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), AUTOPLACER::DoAutoplace(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::DrawVia(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_EDIT_TOOL::EditField(), PCB_IO_KICAD_SEXPR::format(), EDA_TEXT::Format(), PCB_IO_IPC2581::generateLayerSetNet(), SCH_FIELD::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), FIELDS_GRID_TABLE::GetValue(), FIELDS_GRID_TABLE::GetValueAsBool(), PCB_FIELDS_GRID_TABLE::GetValueAsBool(), FEATURES_MANAGER::InitFeatureList(), DRC_RTREE::Insert(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::Matches(), EE_SELECTION_TOOL::narrowSelection(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), LIB_SYMBOL::PlotFields(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), LIB_SYMBOL::Print(), SCH_FIELD::Print(), SCH_TEXT::Print(), DIALOG_CHANGE_SYMBOLS::processSymbols(), processTextItem(), SCH_EDIT_TOOL::Properties(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveField(), SCH_IO_KICAD_LEGACY::saveField(), SCH_IO_KICAD_LEGACY_LIB_CACHE::saveText(), EE_SELECTION_TOOL::Selectable(), EDA_TEXT::Serialize(), and SCH_SHEET_PATH::UpdateAllScreenReferences().

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

References EDA_ITEM::Visit().

Referenced by GERBER_FILE_IMAGE::Visit().

◆ IterateForward() [2/2]

template<class T >

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

inlinestaticinherited

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

Definition at line 316 of file eda_item.h.

References EDA_ITEM::Visit().

◆ KeepUpright()

void PCB_TEXT::KeepUpright ( )

inherited

Called when rotating the parent footprint.

Definition at line 315 of file pcb_text.cpp.

References ANGLE_180, EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetVertJustify(), EDA_TEXT::IsKeepUpright(), EDA_ANGLE::Normalize(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetTextAngle(), and EDA_TEXT::SetVertJustify().

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 166 of file board_item.cpp.

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

Referenced by PAD::GetItemDescription(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), and PCB_TRACK::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 1223 of file eda_text.cpp.

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

Referenced by EDA_TEXT::Similarity().

◆ MapHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::MapHorizJustify ( int aHorizJustify )

staticinherited

Definition at line 67 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(), FIELDS_GRID_TABLE::SetValue(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ MapVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::MapVertJustify ( int aVertJustify )

staticinherited

Definition at line 81 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(), FIELDS_GRID_TABLE::SetValue(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ Matches() [1/2]

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

overridevirtualinherited

Compare the item against the search criteria in aSearchData.

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 169 of file pcb_text.cpp.

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

◆ Matches() [2/2]

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

protectedinherited

Compare aText against search criteria in aSearchData.

This is a helper function for simplify derived class logic.

Parameters

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

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

Definition at line 126 of file eda_item.cpp.

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

◆ Mirror()

void PCB_DIMENSION_BASE::Mirror	(	const VECTOR2I &	axis_pos,
		FLIP_DIRECTION	aFlipDirection
	)

overridevirtualinherited

Mirror the dimension relative to a given horizontal axis.

The text is not mirrored. Only its position (and angle) is mirrored. The layer is not changed.

Parameters

axis_pos is the vertical axis position to mirror around.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_DIM_ALIGNED, and PCB_DIM_ORTHOGONAL.

Definition at line 565 of file pcb_dimension.cpp.

References EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::IsMirrored(), BOARD_ITEM::IsSideSpecific(), PCB_DIMENSION_BASE::m_end, PCB_DIMENSION_BASE::m_start, MIRROR(), EDA_TEXT::SetMirrored(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), and PCB_DIMENSION_BASE::Update().

Referenced by PCB_DIMENSION_BASE::Flip(), PCB_DIM_ALIGNED::Mirror(), and PCB_DIM_ORTHOGONAL::Mirror().

◆ Move()

void PCB_DIMENSION_BASE::Move ( const VECTOR2I & aMoveVector )

overridevirtualinherited

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 527 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_end, PCB_DIMENSION_BASE::m_start, EDA_TEXT::Offset(), and PCB_DIMENSION_BASE::Update().

◆ Normalize()

virtual void BOARD_ITEM::Normalize ( )

inlinevirtualinherited

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

Reimplemented in PCB_SHAPE, and PCB_TABLE.

Definition at line 373 of file board_item.h.

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

◆ NormalizeForCompare()

virtual void BOARD_ITEM::NormalizeForCompare ( )

inlinevirtualinherited

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

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

Reimplemented in PCB_SHAPE.

Definition at line 380 of file board_item.h.

References BOARD_ITEM::Normalize().

◆ Offset()

void EDA_TEXT::Offset ( const VECTOR2I & aOffset )

inherited

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

References EDA_ITEM::GetClass().

◆ operator<() [2/2]

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

inlineinherited

Definition at line 380 of file eda_text.h.

References EDA_TEXT::Compare().

◆ operator==() [1/4]

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

overridevirtualinherited

Implements BOARD_ITEM.

Definition at line 155 of file pcb_dimension.cpp.

References EDA_ITEM::Type().

◆ operator==() [2/4]

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

inlineinherited

Definition at line 379 of file eda_text.h.

References EDA_TEXT::Compare().

Referenced by 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/4]

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

inherited

Definition at line 166 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_arrowLength, PCB_DIMENSION_BASE::m_autoUnits, PCB_DIMENSION_BASE::m_extensionOffset, PCB_DIMENSION_BASE::m_keepTextAligned, PCB_DIMENSION_BASE::m_lineThickness, PCB_DIMENSION_BASE::m_measuredValue, PCB_DIMENSION_BASE::m_precision, PCB_DIMENSION_BASE::m_suppressZeroes, PCB_DIMENSION_BASE::m_textPosition, PCB_DIMENSION_BASE::m_units, PCB_DIMENSION_BASE::m_unitsFormat, and EDA_TEXT::operator==().

◆ operator==() [4/4]

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

inherited

Definition at line 591 of file pcb_text.cpp.

References EDA_TEXT::operator==().

◆ operator>()

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

inlineinherited

Definition at line 381 of file eda_text.h.

References EDA_TEXT::Compare().

◆ Print()

void EDA_TEXT::Print	(	const RENDER_SETTINGS *	aSettings,
		const VECTOR2I &	aOffset,
		const COLOR4D &	aColor,
		OUTLINE_MODE	aDisplay_mode = `FILLED`
	)

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.
aDisplay_mode	FILLED or SKETCH.

Definition at line 856 of file eda_text.cpp.

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

Referenced by SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), and DS_DRAW_ITEM_TEXT::PrintWsItem().

◆ printOneLineOfText()

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

protectedinherited

Print each line of this EDA_TEXT.

Parameters

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

Definition at line 924 of file eda_text.cpp.

References KIGFX::RENDER_SETTINGS::GetDefaultFont(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), EDA_TEXT::getFontMetrics(), EDA_TEXT::GetHorizJustify(), KIGFX::RENDER_SETTINGS::GetPrintDC(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetVertJustify(), GRPrintText(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), SKETCH, and VECTOR2< T >::x.

Referenced by EDA_TEXT::Print().

◆ RemoveHyperlink()

void EDA_TEXT::RemoveHyperlink ( )

inlineinherited

Definition at line 386 of file eda_text.h.

References EDA_TEXT::m_hyperlink.

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 158 of file eda_item.h.

◆ Replace() [1/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 477 of file eda_text.cpp.

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

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

◆ Replace() [2/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_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 404 of file eda_item.h.

◆ Replace() [3/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 189 of file eda_item.cpp.

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

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

◆ Rotate()

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

overridevirtualinherited

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from BOARD_ITEM.

Reimplemented in PCB_DIM_ORTHOGONAL.

Definition at line 538 of file pcb_dimension.cpp.

References EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), PCB_DIMENSION_BASE::m_end, PCB_DIMENSION_BASE::m_start, EDA_ANGLE::Normalize(), RotatePoint(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextPos(), and PCB_DIMENSION_BASE::Update().

Referenced by PCB_DIM_ORTHOGONAL::Rotate().

◆ RunOnChildren()

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

inlinevirtualinherited

Invoke a function on all children.

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

Reimplemented in FOOTPRINT, PCB_GROUP, and PCB_TABLE.

Definition at line 206 of file board_item.h.

Referenced by BOARD_COMMIT::dirtyIntersectingZones(), PCB_IO_KICAD_SEXPR_PARSER::resolveGroups(), KIGFX::PCB_VIEW::Update(), and PCB_SELECTION::updateDrawList().

◆ RunOnDescendants()

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

inlinevirtualinherited

Invoke a function on all descendants.

Note: This function should not add or remove items.

Reimplemented in FOOTPRINT, and PCB_GROUP.

Definition at line 212 of file board_item.h.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), EDIT_TOOL::DeleteItems(), EDIT_TOOL::Duplicate(), PCB_BASE_FRAME::FocusOnItems(), PCB_SELECTION_TOOL::highlightInternal(), PCB_TEST_SELECTION_TOOL::highlightInternal(), ARRAY_TOOL::onDialogClosed(), BOARD_COMMIT::Push(), PCB_GRID_HELPER::queryVisible(), PCB_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::unhighlightInternal(), and PCB_TEST_SELECTION_TOOL::unhighlightInternal().

◆ Serialize()

void PCB_DIM_RADIAL::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_DIMENSION_BASE.

Definition at line 1472 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_end, m_leaderLength, PCB_DIMENSION_BASE::m_start, and PCB_DIMENSION_BASE::Serialize().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 76 of file inspectable.h.

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 59 of file inspectable.h.

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

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

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

◆ SetArrowDirection()

void PCB_DIMENSION_BASE::SetArrowDirection ( const DIM_ARROW_DIRECTION & aDirection )

inlineinherited

Definition at line 201 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_arrowDirection.

Referenced by PCB_DIMENSION_BASE::ChangeArrowDirection(), PCB_DIMENSION_BASE::Deserialize(), DRAWING_TOOL::DrawDimension(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetArrowLength()

void PCB_DIMENSION_BASE::SetArrowLength ( int aLength )

inlineinherited

Definition at line 265 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_arrowLength.

Referenced by PCB_DIMENSION_BASE::Deserialize(), DRAWING_TOOL::DrawDimension(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ 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 424 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and EDA_TEXT::m_pos.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), MULTICHANNEL_TOOL::copyRuleAreaContents(), EDA_TEXT::Deserialize(), PCB_TEXTBOX::Deserialize(), SCH_FIELD::ImportValues(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), SIM_MODEL::MigrateSimModel(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DIALOG_CHANGE_SYMBOLS::processSymbols(), processTextItem(), and CLIPBOARD_IO::SaveSelection().

◆ SetAttributes() [2/2]

void EDA_TEXT::SetAttributes ( const TEXT_ATTRIBUTES & aTextAttrs )

inlineinherited

Definition at line 217 of file eda_text.h.

References EDA_TEXT::m_attributes.

◆ SetAutoUnits()

void PCB_DIMENSION_BASE::SetAutoUnits ( bool aAuto = true )

inlineinherited

Definition at line 225 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_autoUnits.

◆ 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 327 of file eda_text.cpp.

References EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), KIFONT::FONT::GetName(), GetPenSizeForBold(), GetPenSizeForNormal(), EDA_TEXT::IsItalic(), KIFONT::FONT::IsStroke(), EDA_TEXT::m_attributes, TEXT_ATTRIBUTES::m_Bold, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StoredStrokeWidth, TEXT_ATTRIBUTES::m_StrokeWidth, EDA_TEXT::SetBoldFlag(), EDA_TEXT::SetFont(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_IO_ALTIUM::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), SCH_EDIT_TOOL::ChangeTextType(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_IO_EAGLE::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_IO_EAGLE::loadTextAttributes(), DIALOG_LABEL_PROPERTIES::OnAddField(), SCH_IO_ALTIUM::ParseHarnessPort(), SCH_IO_ALTIUM::ParseLabel(), FIELDS_GRID_TABLE::SetValue(), FIELDS_GRID_TABLE::SetValueAsBool(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetBoldFlag()

void EDA_TEXT::SetBoldFlag ( bool aBold )

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 369 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, TEXT_ATTRIBUTES::m_Bold, and EDA_TEXT::m_bounding_box_cache_valid.

Referenced by ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_KICAD_LEGACY::loadSymbol(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), EDA_TEXT::SetBold(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 120 of file eda_item.h.

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetEnd()

virtual void PCB_DIMENSION_BASE::SetEnd ( const VECTOR2I & aPoint )

inlinevirtualinherited

Definition at line 135 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_end.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), DRAWING_TOOL::constrainDimension(), PCB_DIM_ALIGNED::Deserialize(), PCB_DIM_ORTHOGONAL::Deserialize(), Deserialize(), PCB_DIM_LEADER::Deserialize(), PCB_DIM_CENTER::Deserialize(), DRAWING_TOOL::DrawDimension(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), PCB_IO_EAGLE::loadPlain(), ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateAlignedDimension(), DIM_CENTER_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_LEADER_POINT_EDIT_BEHAVIOR::UpdateItem(), and ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateOrthogonalDimension().

◆ SetExtensionOffset()

void PCB_DIMENSION_BASE::SetExtensionOffset ( int aOffset )

inlineinherited

Definition at line 267 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_extensionOffset.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), PCB_DIMENSION_BASE::Deserialize(), DRAWING_TOOL::DrawDimension(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 127 of file eda_item.h.

References EDA_ITEM::m_flags.

◆ SetFont()

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

inherited

Definition at line 490 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Font.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), SCH_IO_KICAD_SEXPR_PARSER::removeEntryInFontTextMap(), EDA_TEXT::SetBold(), EDA_TEXT::SetFontIndex(), EDA_TEXT::SetItalic(), FIELDS_GRID_TABLE::SetValue(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetFontIndex()

void EDA_TEXT::SetFontIndex ( int aIdx )

inherited

Definition at line 1000 of file eda_text.cpp.

References Fontconfig(), KIFONT::FONT::GetFont(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), Pgm(), and EDA_TEXT::SetFont().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ SetForcedTransparency()

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

inlineinherited

Definition at line 153 of file view_item.h.

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

◆ SetForceVisible()

void EDA_ITEM::SetForceVisible ( bool aEnable )

inlineinherited

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

Parameters

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

Definition at line 194 of file eda_item.h.

References EDA_ITEM::m_forceVisible.

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

◆ SetFPRelativePosition()

void BOARD_ITEM::SetFPRelativePosition ( const VECTOR2I & aPos )

inherited

Definition at line 341 of file board_item.cpp.

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

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

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( GR_TEXT_H_ALIGN_T aType )

inherited

Definition at line 400 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Halign.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_IO_ALTIUM::AddLibTextBox(), SCH_IO_ALTIUM::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), FOOTPRINT::AutoPositionFields(), SCH_DRAWING_TOOLS::createNewText(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::FlipHJustify(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), ALTIUM_PCB::HelperSetTextboxAlignmentAndPos(), AUTOPLACER::justifyField(), PCB_TEXT::KeepUpright(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_EAGLE::loadFieldAttributes(), SCH_IO_EAGLE::loadFrame(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_TEXT::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_ALTIUM::ParseHarnessPort(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_TEXTBOX::PCB_TEXTBOX(), SCH_FIELD::Rotate(), SCH_TEXTBOX::SCH_TEXTBOX(), SCH_FIELD::SetEffectiveHorizJustify(), SCH_LABEL_BASE::SetSpinStyle(), SCH_IO_LTSPICE_PARSER::setTextJustification(), PCAD2KICAD::SetTextJustify(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), swapFieldPositionsWithMatching(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_FIELD_PROPERTIES::UpdateField(), and DIM_ALIGNED_TEXT_UPDATER::UpdateTextAfterChange().

◆ SetHyperlink()

void EDA_TEXT::SetHyperlink ( wxString aLink )

inlineinherited

Definition at line 385 of file eda_text.h.

References EDA_TEXT::m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT::Deserialize(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), CLIPBOARD_IO::SaveSelection(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Definition at line 325 of file board_item.h.

References BOARD_ITEM::m_isKnockout.

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

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 160 of file eda_item.h.

References EDA_ITEM::ClearFlags(), IS_SHOWN_AS_BITMAP, and EDA_ITEM::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 299 of file eda_text.cpp.

References EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), KIFONT::FONT::GetName(), EDA_TEXT::IsBold(), KIFONT::FONT::IsStroke(), EDA_TEXT::m_attributes, TEXT_ATTRIBUTES::m_Italic, EDA_TEXT::SetFont(), and EDA_TEXT::SetItalicFlag().

Referenced by SCH_IO_ALTIUM::AddTextBox(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), SCH_IO_ALTIUM::ParseHarnessPort(), 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(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), 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 319 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Italic.

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

◆ SetKeepTextAligned()

void PCB_DIMENSION_BASE::SetKeepTextAligned ( bool aKeepAligned )

inlineinherited

Definition at line 255 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_keepTextAligned.

Referenced by PCB_DIMENSION_BASE::ChangeKeepTextAligned(), PCB_DIMENSION_BASE::Deserialize(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetKeepUpright()

void EDA_TEXT::SetKeepUpright ( bool aKeepUpright )

inherited

Definition at line 416 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_KeepUpright.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCB_BASE_FRAME::CreateNewFootprint(), PCB_IO_EAGLE::loadPlain(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_TEXT::PCB_TEXT(), PCB_TEXT_DESC::PCB_TEXT_DESC(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValueAsBool(), PCB_TEXT::StyleFromSettings(), and PCB_TEXTBOX::StyleFromSettings().

◆ SetLayer()

virtual void BOARD_ITEM::SetLayer ( PCB_LAYER_ID aLayer )

inlinevirtualinherited

Set the layer this item is on.

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

Parameters

aLayer The layer number.

Reimplemented in PCB_GENERATOR, PCB_GROUP, PCB_SHAPE, PCB_VIA, and ZONE.

Definition at line 288 of file board_item.h.

References BOARD_ITEM::m_layer.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_LINE::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), BOARD_CONNECTED_ITEM_DESC::BOARD_CONNECTED_ITEM_DESC(), BOARD_ITEM_DESC::BOARD_ITEM_DESC(), BOOST_AUTO_TEST_CASE(), ALTIUM_PCB::ConvertTexts6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), PNS_KICAD_IFACE::createBoardItem(), PCB_BASE_FRAME::CreateNewFootprint(), BOARD_ADAPTER::createTrackWithMargin(), FOOTPRINT::Deserialize(), PAD::Deserialize(), PCB_DIMENSION_BASE::Deserialize(), PCB_FIELD::Deserialize(), PCB_TEXT::Deserialize(), PCB_TRACK::Deserialize(), PCB_ARC::Deserialize(), EDIT_TOOL::DragArcTrack(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::DrawTable(), EDIT_TOOL::FilletTracks(), PCB_IO_EASYEDAPRO_PARSER::fillFootprintModelInfo(), FOOTPRINT::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_TABLE::Flip(), PCB_TARGET::Flip(), PCB_TEXT::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), FOOTPRINT::FOOTPRINT(), PNS_PCBNEW_RULE_RESOLVER::getBoardItem(), DRAWING_TOOL::InteractivePlaceWithPreview(), FABMASTER::loadEtch(), PCB_IO_KICAD_LEGACY::loadFOOTPRINT(), FABMASTER::loadFootprints(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), PCB_IO_EAGLE::loadSignals(), PCB_IO_KICAD_LEGACY::loadTrackList(), main(), DSN::SPECCTRA_DB::makeTRACK(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), PCB_MARKER::PCB_MARKER(), PCB_REFERENCE_IMAGE_DESC::PCB_REFERENCE_IMAGE_DESC(), PCB_TEXT::PCB_TEXT(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), processTextItem(), CLIPBOARD_IO::SaveSelection(), PCB_SHAPE::SetLayer(), BOARD_ITEM::SetLayerSet(), PCB_TRACK::SetLayerSet(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValueAsLong(), EDIT_TOOL::Swap(), DRC_TEST_PROVIDER_CREEPAGE::testCreepage(), DIALOG_REFERENCE_IMAGE_PROPERTIES::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), BOARD_NETLIST_UPDATER::updateFootprintParameters(), and ROUTER_TOOL::updateSizesAfterRouterEvent().

◆ SetLayerSet()

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

inlinevirtualinherited

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

Definition at line 265 of file board_item.h.

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

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

◆ SetLeaderLength()

void PCB_DIM_RADIAL::SetLeaderLength ( int aLength )

inline

Definition at line 597 of file pcb_dimension.h.

References m_leaderLength.

Referenced by ChangeLeaderLength(), Deserialize(), PCB_IO_KICAD_SEXPR_PARSER::parseDIMENSION(), and DIM_RADIAL_POINT_EDIT_BEHAVIOR::UpdateItem().

◆ SetLineSpacing()

void EDA_TEXT::SetLineSpacing ( double aLineSpacing )

inherited

Definition at line 498 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_LineSpacing.

Referenced by PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), and SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT().

◆ SetLineThickness()

void PCB_DIMENSION_BASE::SetLineThickness ( int aWidth )

inlineinherited

Definition at line 271 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_lineThickness.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), PCB_DIMENSION_BASE::Deserialize(), DRAWING_TOOL::DrawDimension(), PCB_IO_EAGLE::loadPlain(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

Reimplemented in PCB_GROUP, and FOOTPRINT.

Definition at line 328 of file board_item.h.

References BOARD_ITEM::m_isLocked.

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

◆ SetMeasuredValue()

void PCB_DIMENSION_BASE::SetMeasuredValue ( int aValue )

inlineinherited

Definition at line 156 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_measuredValue.

◆ SetMirrored()

void EDA_TEXT::SetMirrored ( bool isMirrored )

inherited

Definition at line 384 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Mirrored.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), PCB_DIMENSION_BASE::Mirror(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), PCB_TABLECELL::PCB_TABLECELL(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValueAsBool(), PCB_FIELDS_GRID_TABLE::SetValueAsLong(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 67 of file eda_item.cpp.

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

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

◆ SetMultilineAllowed()

void EDA_TEXT::SetMultilineAllowed ( bool aAllow )

inherited

Parameters

aAllow true if ok to use multiline option, false if ok to use only single line text. (Single line is faster in calculations than multiline.)

Definition at line 392 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Multiline.

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

◆ SetOverrideText()

void PCB_DIMENSION_BASE::SetOverrideText ( const wxString & aValue )

inlineinherited

Definition at line 144 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_valueString.

Referenced by PCB_DIMENSION_BASE::ChangeOverrideText(), PCB_DIMENSION_BASE::Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), PCB_IO_EAGLE::loadPlain(), PCB_DIM_LEADER::PCB_DIM_LEADER(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetOverrideTextEnabled()

void PCB_DIMENSION_BASE::SetOverrideTextEnabled ( bool aOverride )

inlineinherited

Definition at line 141 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_overrideTextEnabled.

Referenced by PCB_DIMENSION_BASE::ChangeOverrideText(), PCB_DIMENSION_BASE::Deserialize(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and NETINFO_ITEM.

Definition at line 104 of file eda_item.h.

References EDA_ITEM::m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), PCB_TABLE::AddCell(), SCH_TABLE::AddCell(), LIB_SYMBOL::AddDrawItem(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PADSTACK::AddPrimitive(), PAD::AddPrimitivePoly(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), BOOST_AUTO_TEST_CASE(), CADSTAR_SCH_ARCHIVE_LOADER::copySymbolItems(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SCH_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawTable(), PCB_EDIT_FRAME::ExchangeFootprint(), PAD_TOOL::explodePad(), LIB_SYMBOL::Flatten(), PCB_IO_KICAD_SEXPR::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), PCB_TABLE::InsertCell(), SCH_TABLE::InsertCell(), LIB_SYMBOL::LIB_SYMBOL(), LTSPICE_SCHEMATIC::Load(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_IO_KICAD_SEXPR::loadHierarchy(), SCH_IO_KICAD_LEGACY::loadHierarchy(), KI_TEST::LoadHierarchy(), SCH_IO_EAGLE::loadSymbolCircle(), 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(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), PAD::Recombine(), SCH_IO_LIB_CACHE::removeSymbol(), SCH_EDIT_TOOL::RepeatDrawItem(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CLIPBOARD_IO::SaveSelection(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), FOOTPRINT::swapData(), PCB_TABLE::swapData(), SCH_LABEL_BASE::SwapData(), SCH_SHEET::SwapData(), SCH_SYMBOL::SwapData(), SCH_TABLE::SwapData(), BOARD_ITEM::SwapItemData(), SCH_SYMBOL::SyncOtherUnits(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

◆ SetPosition()

void PCB_DIMENSION_BASE::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtualinherited

Reimplemented from PCB_TEXT.

Definition at line 138 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_start.

◆ SetPrecision()

void PCB_DIMENSION_BASE::SetPrecision ( DIM_PRECISION aPrecision )

inlineinherited

Definition at line 237 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_precision.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), PCB_DIMENSION_BASE::ChangePrecision(), PCB_DIMENSION_BASE::Deserialize(), PCB_IO_EAGLE::loadPlain(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetPrefix()

void PCB_DIMENSION_BASE::SetPrefix ( const wxString & aPrefix )

inherited

Definition at line 447 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_prefix.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), PCB_DIMENSION_BASE::ChangePrefix(), PCB_DIMENSION_BASE::Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 119 of file eda_item.h.

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetStart()

virtual void PCB_DIMENSION_BASE::SetStart ( const VECTOR2I & aPoint )

inlinevirtualinherited

Definition at line 132 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_start.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), PCB_DIM_ALIGNED::Deserialize(), PCB_DIM_ORTHOGONAL::Deserialize(), Deserialize(), PCB_DIM_LEADER::Deserialize(), PCB_DIM_CENTER::Deserialize(), DRAWING_TOOL::DrawDimension(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), PCB_IO_EAGLE::loadPlain(), ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateAlignedDimension(), DIM_CENTER_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_LEADER_POINT_EDIT_BEHAVIOR::UpdateItem(), and ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateOrthogonalDimension().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 94 of file board_item.cpp.

References EDA_ITEM::GetClass().

◆ SetSuffix()

void PCB_DIMENSION_BASE::SetSuffix ( const wxString & aSuffix )

inherited

Definition at line 453 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_suffix.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), PCB_DIMENSION_BASE::ChangeSuffix(), PCB_DIMENSION_BASE::Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetSuppressZeroes()

void PCB_DIMENSION_BASE::SetSuppressZeroes ( bool aSuppress )

inlineinherited

Definition at line 246 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_suppressZeroes.

Referenced by PCB_DIMENSION_BASE::ChangeSuppressZeroes(), PCB_DIMENSION_BASE::Deserialize(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetText()

void EDA_TEXT::SetText ( const wxString & aText )

virtualinherited

Reimplemented in SCH_FIELD.

Definition at line 269 of file eda_text.cpp.

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

◆ SetTextAngle()

void EDA_TEXT::SetTextAngle ( const EDA_ANGLE & aAngle )

virtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 291 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), TEXT_ATTRIBUTES::m_Angle, EDA_TEXT::m_attributes, and EDA_TEXT::m_bounding_box_cache_valid.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), FOOTPRINT::AutoPositionFields(), SCH_DRAWING_TOOLS::createNewText(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_IO_EASYEDA::FootprintLoad(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), PCB_TEXT::KeepUpright(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_EAGLE::loadFieldAttributes(), FABMASTER::loadFootprints(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SCH_IO_KICAD_LEGACY::loadSymbol(), PCB_TEXTBOX::Mirror(), PCB_DIMENSION_BASE::Mirror(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_KICAD_SEXPR_PARSER::parseSchTextBoxContent(), SCH_TEXTBOX::Plot(), SCH_EDIT_TOOL::Rotate(), SCH_FIELD::Rotate(), SCH_TEXTBOX::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), PCB_TEXTBOX::Rotate(), SCH_TEXT::Rotate90(), SCH_TEXTBOX::Rotate90(), CLIPBOARD_IO::SaveSelection(), SCH_LABEL_BASE::SetSpinStyle(), EDA_TEXT::SetTextAngleDegrees(), SCH_IO_LTSPICE_PARSER::setTextJustification(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), PCB_FIELDS_GRID_TABLE::SetValue(), swapFieldPositionsWithMatching(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_ORTHOGONAL::updateText(), updateText(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextAngleDegrees()

void EDA_TEXT::SetTextAngleDegrees ( double aOrientation )

inlineinherited

Definition at line 137 of file eda_text.h.

References DEGREES_T, and EDA_TEXT::SetTextAngle().

Referenced by PCB_DIMENSION_BASE::ChangeTextAngleDegrees(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_EASYEDA_PARSER::ParseSchematic(), and SCH_EASYEDA_PARSER::ParseSymbolShapes().

◆ SetTextColor()

void EDA_TEXT::SetTextColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 253 of file eda_text.h.

References EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Color.

Referenced by DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_ALTIUM::ParseHarnessPort(), SCH_IO_ALTIUM::ParseHarnessType(), FIELDS_GRID_TABLE::SetValue(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextHeight()

void EDA_TEXT::SetTextHeight ( int aHeight )

inherited

Definition at line 540 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, EDA_TEXT::m_IuScale, TEXT_ATTRIBUTES::m_Size, TEXT_MAX_SIZE_MM, TEXT_MIN_SIZE_MM, and VECTOR2< T >::y.

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 )

inherited

Definition at line 551 of file eda_text.cpp.

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

Referenced by PCAD2KICAD::PCAD_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), SCH_FIELD::BeginEdit(), SCH_TEXT::BeginEdit(), BOOST_AUTO_TEST_CASE(), SCH_FIELD::CalcEdit(), SCH_TEXT::CalcEdit(), EDA_TEXT::Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), ALTIUM_PCB::HelperSetTextAlignmentAndPos(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_IO_EAGLE::loadFieldAttributes(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), 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(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_FIELD::SCH_FIELD(), 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(), ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateAlignedDimension(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_FIELD_PROPERTIES::UpdateField(), SCH_SYMBOL::UpdateFields(), DIM_RADIAL_POINT_EDIT_BEHAVIOR::UpdateItem(), DIM_LEADER_POINT_EDIT_BEHAVIOR::UpdateItem(), ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateOrthogonalDimension(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_ORTHOGONAL::updateText(), and DIM_ALIGNED_TEXT_UPDATER::UpdateTextAfterChange().

◆ SetTextPositionMode()

void PCB_DIMENSION_BASE::SetTextPositionMode ( DIM_TEXT_POSITION aMode )

inlineinherited

Definition at line 261 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_textPosition.

Referenced by PCB_DIMENSION_BASE::Deserialize(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateAlignedDimension(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and ALIGNED_DIMENSION_POINT_EDIT_BEHAVIOR::updateOrthogonalDimension().

◆ SetTextSize()

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

inherited

Definition at line 506 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_IU_SCALE::IU_PER_MM, EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, EDA_TEXT::m_IuScale, TEXT_ATTRIBUTES::m_Size, TEXT_MAX_SIZE_MM, TEXT_MIN_SIZE_MM, unityScale, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_IO_EAGLE::addImplicitConnections(), SCH_IO_ALTIUM::AddLibTextBox(), SCH_IO_ALTIUM::AddTextBox(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), MICROWAVE_TOOL::createBaseFootprint(), SCH_IO_LTSPICE_PARSER::CreateFields(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), SCH_IO_LTSPICE_PARSER::CreatePowerSymbol(), SCH_IO_LTSPICE_PARSER::CreateSCH_LABEL(), SCH_IO_LTSPICE_PARSER::CreateSCH_TEXT(), SYMBOL_EDITOR_DRAWING_TOOLS::doDrawShape(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), SCH_DRAWING_TOOLS::DrawTable(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT::EDA_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), SCH_IO_EAGLE::loadFieldAttributes(), SCH_IO_EAGLE::loadFrame(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_IO_KICAD_LEGACY::loadSheet(), SCH_IO_KICAD_LEGACY::loadSymbol(), SCH_IO_EAGLE::loadTextAttributes(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_ALTIUM::ParseHarnessPort(), SCH_IO_ALTIUM::ParseLabel(), SCH_IO_ALTIUM::ParseLibDesignator(), SCH_IO_ALTIUM::ParseLibParameter(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), BACK_ANNOTATE::processNetNameChange(), SCH_FIELD::SetSchTextSize(), SCH_TEXT::SetSchTextSize(), SCH_TEXTBOX::SetSchTextSize(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), FIELDS_GRID_TABLE::SetValue(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextThickness()

void EDA_TEXT::SetTextThickness ( int aWidth )

inherited

The TextThickness is that set by the user.

The EffectiveTextPenWidth also factors in bold text and thickness clamping.

Definition at line 283 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_StrokeWidth.

Referenced by PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCAD_TEXT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextCodeIfExists(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), PCB_TEXT::PCB_TEXT(), FABMASTER::setupText(), PCB_FIELDS_GRID_TABLE::SetValue(), PCB_TEXT::StyleFromSettings(), PCB_TEXTBOX::StyleFromSettings(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetTextWidth()

void EDA_TEXT::SetTextWidth ( int aWidth )

inherited

Definition at line 529 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, EDA_TEXT::m_IuScale, TEXT_ATTRIBUTES::m_Size, TEXT_MAX_SIZE_MM, TEXT_MIN_SIZE_MM, and VECTOR2< T >::x.

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

◆ SetTextX()

void EDA_TEXT::SetTextX ( int aX )

inherited

Definition at line 557 of file eda_text.cpp.

References EDA_TEXT::m_pos, EDA_TEXT::Offset(), and VECTOR2< T >::x.

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), PCB_TEXT::Flip(), PCB_TEXT::Mirror(), SCH_FIELD::MirrorHorizontally(), SCH_DIRECTIVE_LABEL::MirrorHorizontally(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), and SCH_SHEET_PIN::SetSide().

◆ SetTextY()

void EDA_TEXT::SetTextY ( int aY )

inherited

Definition at line 563 of file eda_text.cpp.

References EDA_TEXT::m_pos, EDA_TEXT::Offset(), and VECTOR2< T >::y.

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), PCB_TEXT::Flip(), PCB_TEXT::Mirror(), SCH_FIELD::MirrorVertically(), SCH_DIRECTIVE_LABEL::MirrorVertically(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), and SCH_SHEET_PIN::SetSide().

◆ SetUnits()

void PCB_DIMENSION_BASE::SetUnits ( EDA_UNITS aUnits )

inherited

Definition at line 459 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_units.

Referenced by PCB_IO_EAGLE::loadPlain().

◆ SetUnitsFormat()

void PCB_DIMENSION_BASE::SetUnitsFormat ( const DIM_UNITS_FORMAT aFormat )

inlineinherited

Definition at line 228 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::m_unitsFormat.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), PCB_DIMENSION_BASE::ChangeUnitsFormat(), PCB_DIMENSION_BASE::Deserialize(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), and DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog().

◆ SetUnitsMode()

void PCB_DIMENSION_BASE::SetUnitsMode ( DIM_UNITS_MODE aMode )

inherited

Definition at line 484 of file pcb_dimension.cpp.

References BOARD_ITEM::GetBoard(), BOARD::GetUserUnits(), PCB_DIMENSION_BASE::m_autoUnits, and PCB_DIMENSION_BASE::m_units.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), PCB_DIMENSION_BASE::ChangeUnitsMode(), PCB_DIMENSION_BASE::Deserialize(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), and PCB_DIMENSION_BASE::UpdateUnits().

◆ SetupRenderCache()

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

inherited

Definition at line 679 of file eda_text.cpp.

References EDA_TEXT::m_render_cache, EDA_TEXT::m_render_cache_angle, EDA_TEXT::m_render_cache_font, EDA_TEXT::m_render_cache_offset, and EDA_TEXT::m_render_cache_text.

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( GR_TEXT_V_ALIGN_T aType )

inherited

Definition at line 408 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and TEXT_ATTRIBUTES::m_Valign.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), FOOTPRINT::AutoPositionFields(), SCH_DRAWING_TOOLS::createNewText(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), 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(), SCH_IO_EAGLE::loadFieldAttributes(), SCH_IO_EAGLE::loadFrame(), PCB_IO_KICAD_LEGACY::loadMODULE_TEXT(), PCB_IO_KICAD_LEGACY::loadPCB_TEXT(), PCB_IO_EAGLE::loadPlain(), SCH_IO_KICAD_LEGACY::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymdef(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_TEXT::MirrorHorizontally(), SCH_TEXT::MirrorVertically(), PCB_IO_EAGLE::orientFPText(), PCB_IO_EAGLE::packageText(), PCB_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_IO_KICAD_SEXPR_PARSER::parseEDA_TEXT(), SCH_EASYEDA_PARSER::ParseSchematic(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_TEXTBOX::PCB_TEXTBOX(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_TEXTBOX::SCH_TEXTBOX(), SCH_FIELD::SetEffectiveVertJustify(), SCH_LABEL_BASE::SetSpinStyle(), SCH_GLOBALLABEL::SetSpinStyle(), SCH_HIERLABEL::SetSpinStyle(), SCH_IO_LTSPICE_PARSER::setTextJustification(), PCAD2KICAD::SetTextJustify(), FABMASTER::setupText(), FIELDS_GRID_TABLE::SetValue(), swapFieldPositionsWithMatching(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_FIELD_PROPERTIES::UpdateField().

◆ SetVisible()

void EDA_TEXT::SetVisible ( bool aVisible )

virtualinherited

Reimplemented in PCB_TEXTBOX.

Definition at line 377 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, and TEXT_ATTRIBUTES::m_Visible.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), CADSTAR_SCH_ARCHIVE_LOADER::addNewFieldToSymbol(), PCAD2KICAD::PCAD_FOOTPRINT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyTextCode(), SCH_EDITOR_CONTROL::AssignFootprints(), SCH_EDIT_TOOL::ChangeTextType(), SCH_IO_LTSPICE_PARSER::CreateFields(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_IO_LTSPICE_PARSER::CreatePowerSymbol(), SCH_IO_LTSPICE_PARSER::CreateSCH_LABEL(), SCH_IO_LTSPICE_PARSER::CreateSCH_TEXT(), EDIT_TOOL::DeleteItems(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SCH_DRAWING_TOOLS::DrawSheet(), EDA_TEXT_DESC::EDA_TEXT_DESC(), PCB_IO_EASYEDAPRO_PARSER::fillFootprintModelInfo(), FOOTPRINT::FOOTPRINT(), PCB_IO_EASYEDA::FootprintLoad(), PCB_IO_EASYEDAPRO::FootprintLoad(), SCH_IO_EAGLE::getEagleSymbolFieldAttributes(), LIB_SYMBOL::LIB_SYMBOL(), CADSTAR_SCH_ARCHIVE_LOADER::loadBusses(), PCB_IO_EAGLE::loadElements(), SCH_IO_KICAD_LEGACY_LIB_CACHE::loadField(), FABMASTER::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(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), 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(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LABEL_PROPERTIES::OnAddField(), 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::ParseHarnessType(), SCH_IO_ALTIUM::ParseLibParameter(), SCH_IO_ALTIUM::ParseParameter(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_TEXT_effects(), SCH_IO_ALTIUM::ParsePowerPort(), SCH_IO_KICAD_SEXPR_PARSER::parseSchText(), SCH_IO_ALTIUM::ParseSheetName(), SCH_EASYEDAPRO_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbol(), SCH_EASYEDA_PARSER::ParseSymbolShapes(), PCB_IO_EASYEDA_PARSER::ParseToBoardItemContainer(), SCH_EDITOR_CONTROL::processCmpToFootprintLinkFile(), DIALOG_CHANGE_SYMBOLS::processSymbols(), processTextItem(), SCH_IO_KICAD_SEXPR_LIB_CACHE::saveDcmInfoAsFields(), SCH_FIELD::SCH_FIELD(), 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().

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 116 of file board_item.h.

References BOARD_ITEM::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 122 of file board_item.h.

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

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

◆ Similarity() [1/2]

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

overridevirtualinherited

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

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

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

Implements BOARD_ITEM.

Definition at line 205 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_arrowLength, PCB_DIMENSION_BASE::m_autoUnits, PCB_DIMENSION_BASE::m_extensionOffset, PCB_DIMENSION_BASE::m_keepTextAligned, PCB_DIMENSION_BASE::m_lineThickness, PCB_DIMENSION_BASE::m_measuredValue, PCB_DIMENSION_BASE::m_precision, PCB_DIMENSION_BASE::m_suppressZeroes, PCB_DIMENSION_BASE::m_textPosition, PCB_DIMENSION_BASE::m_units, PCB_DIMENSION_BASE::m_unitsFormat, EDA_ITEM::m_Uuid, EDA_TEXT::Similarity(), and EDA_ITEM::Type().

◆ Similarity() [2/2]

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

inherited

Definition at line 1269 of file eda_text.cpp.

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

Referenced by PCB_TEXT::Similarity(), PCB_TEXTBOX::Similarity(), PCB_DIMENSION_BASE::Similarity(), PCB_FIELD::Similarity(), SCH_FIELD::Similarity(), SCH_TEXT::Similarity(), and SCH_TEXTBOX::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 433 of file eda_item.h.

◆ StyleFromSettings()

void PCB_TEXT::StyleFromSettings ( const BOARD_DESIGN_SETTINGS & settings )

overridevirtualinherited

Reimplemented from BOARD_ITEM.

Definition at line 305 of file pcb_text.cpp.

References BOARD_ITEM::GetLayer(), 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(), EDA_TEXT::SetTextSize(), and EDA_TEXT::SetTextThickness().

Referenced by DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), PCB_IO_KICAD_SEXPR_PARSER::parseFOOTPRINT_unchecked(), and BOARD_NETLIST_UPDATER::updateFootprintParameters().

◆ SwapAttributes()

void EDA_TEXT::SwapAttributes ( EDA_TEXT & aTradingPartner )

inherited

Swap the text attributes of the two involved instances.

Definition at line 443 of file eda_text.cpp.

References EDA_TEXT::ClearRenderCache(), EDA_TEXT::m_attributes, EDA_TEXT::m_bounding_box_cache_valid, and EDA_TEXT::m_pos.

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

◆ swapData()

void PCB_DIM_RADIAL::swapData ( BOARD_ITEM * aImage )

overrideprotectedvirtual

Reimplemented from PCB_TEXT.

Definition at line 1517 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::m_shapes, EDA_ITEM::Type(), and PCB_DIMENSION_BASE::Update().

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

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

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

◆ SwapText()

void EDA_TEXT::SwapText ( EDA_TEXT & aTradingPartner )

inherited

Definition at line 436 of file eda_text.cpp.

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

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

◆ TextHitTest() [1/2]

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

overridevirtualinherited

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

Definition at line 360 of file pcb_text.cpp.

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

◆ TextHitTest() [2/2]

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

overridevirtualinherited

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

Definition at line 349 of file pcb_text.cpp.

References GetKnockoutTextMargin(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), BOARD_ITEM::IsKnockout(), and EDA_TEXT::TextHitTest().

Referenced by PCB_DIMENSION_BASE::HitTest(), and PCB_TEXT::HitTest().

◆ TransformShapeToPolygon()

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

overridevirtualinherited

Convert the item shape to a closed polygon.

Circles and arcs are approximated by segments.

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 766 of file pcb_dimension.cpp.

References SEG::A, SEG::B, SHAPE_CIRCLE::GetCenter(), SHAPE_CIRCLE::GetRadius(), SHAPE_SEGMENT::GetSeg(), PCB_DIMENSION_BASE::m_lineThickness, PCB_DIMENSION_BASE::m_shapes, TransformCircleToPolygon(), and TransformOvalToPolygon().

Referenced by ZONE_FILLER::addKnockout(), and BOARD::ConvertBrdLayerToPolygonalContours().

◆ TransformTextToPolySet()

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

inherited

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

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 510 of file pcb_text.cpp.

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::BooleanSubtract(), PCB_TEXT::buildBoundingHull(), KIFONT::FONT::Draw(), ERROR_OUTSIDE, EDA_TEXT::GetAttributes(), EDA_TEXT::getDrawFont(), PCB_TEXT::GetDrawRotation(), EDA_TEXT::GetEffectiveTextPenWidth(), BOARD_ITEM::GetFontMetrics(), GetKnockoutTextMargin(), PCB_TEXT::GetShownText(), EDA_TEXT::GetTextPos(), SHAPE_POLY_SET::Inflate(), BOARD_ITEM::IsKnockout(), TEXT_ATTRIBUTES::m_Angle, TEXT_ATTRIBUTES::m_Size, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::Simplify(), and TransformOvalToPolygon().

Referenced by PCB_IO_IPC2581::addKnockoutText(), BOARD_ADAPTER::addText(), BOARD::ConvertBrdLayerToPolygonalContours(), KIGFX::PCB_PAINTER::draw(), PCB_TEXT::GetEffectiveShape(), and PCB_TEXT::TransformShapeToPolygon().

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

References EDA_ITEM::m_structType.

◆ Update()

void PCB_DIMENSION_BASE::Update ( )

inlineinherited

Update the dimension's cached text and geometry.

Call this whenever you change something in the geometry definition, or the text (which can affect geometry, e.g. by a knockout of a crossbar line or similar)

Definition at line 170 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::updateGeometry().

◆ updateGeometry()

void PCB_DIM_RADIAL::updateGeometry ( )

overrideprotectedvirtual

Update the cached geometry of the dimension after changing any of its properties.

Implements PCB_DIMENSION_BASE.

Definition at line 1566 of file pcb_dimension.cpp.

References ANGLE_90, SHAPE_POLY_SET::Append(), SEG::B, CollectKnockedOutSegments(), PCB_DIMENSION_BASE::drawAnArrow(), VECTOR2< T >::EuclideanNorm(), BOX2< Vec >::GetCenter(), EDA_TEXT::GetEffectiveTextPenWidth(), BOX2< Vec >::GetEnd(), BOX2< Vec >::GetOrigin(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextPos(), EDA_TEXT::GetTextWidth(), BOX2< Vec >::Inflate(), KiROUND(), PCB_DIMENSION_BASE::m_arrowLength, PCB_DIMENSION_BASE::m_end, m_leaderLength, PCB_DIMENSION_BASE::m_measuredValue, PCB_DIMENSION_BASE::m_shapes, PCB_DIMENSION_BASE::m_start, SHAPE_POLY_SET::NewOutline(), VECTOR2< T >::Resize(), SHAPE_POLY_SET::Rotate(), RotatePoint(), updateText(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ updateText()

void PCB_DIM_RADIAL::updateText ( )

overrideprotectedvirtual

Update the text field value from the current geometry (called by updateGeometry normally).

If you change the text, you should call updateGeometry which will call this, and also handle any text-dependent geoemtry handling (like a knockout)

Reimplemented from PCB_DIMENSION_BASE.

Definition at line 1544 of file pcb_dimension.cpp.

References ANGLE_180, ANGLE_270, ANGLE_90, EDA_ANGLE::AsDegrees(), DEGREES_T, FULL_CIRCLE, GetKnee(), EDA_TEXT::GetTextPos(), KiROUND(), PCB_DIMENSION_BASE::m_keepTextAligned, EDA_ANGLE::Normalize(), EDA_TEXT::SetTextAngle(), and PCB_DIMENSION_BASE::updateText().

Referenced by updateGeometry().

◆ UpdateUnits()

void PCB_DIMENSION_BASE::UpdateUnits ( )

inlineinherited

Definition at line 176 of file pcb_dimension.h.

References PCB_DIMENSION_BASE::GetUnitsMode(), PCB_DIMENSION_BASE::SetUnitsMode(), and PCB_DIMENSION_BASE::Update().

Referenced by BOARD::UpdateUserUnits().

◆ 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 1213 of file eda_text.cpp.

References EDA_TEXT::IsGotoPageHref().

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

◆ ViewBBox()

const BOX2I PCB_DIMENSION_BASE::ViewBBox ( ) const

overridevirtualinherited

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

Returns: the current bounding box.

Reimplemented from EDA_ITEM.

Reimplemented in PCB_DIM_CENTER.

Definition at line 756 of file pcb_dimension.cpp.

References PCB_DIMENSION_BASE::GetBoundingBox(), PCB_DIMENSION_BASE::GetPosition(), BOX2< Vec >::Merge(), and PCB_TEXT::ViewBBox().

◆ ViewDraw()

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

inlinevirtualinherited

Draw the parts of the object belonging to layer aLayer.

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

Parameters

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

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

Definition at line 119 of file view_item.h.

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

◆ ViewGetLayers()

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

overridevirtualinherited

Reimplemented from BOARD_ITEM.

Definition at line 203 of file pcb_text.cpp.

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

◆ ViewGetLOD()

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

overridevirtualinherited

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.

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 show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented from KIGFX::VIEW_ITEM.

Definition at line 212 of file pcb_text.cpp.

References B_Cu, F_Cu, KIGFX::RENDER_SETTINGS::GetHighContrast(), BOARD_ITEM::GetLayer(), KIGFX::VIEW::GetPainter(), BOARD_ITEM::GetParentFootprint(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), KIGFX::PCB_PAINTER::GetSettings(), EDA_TEXT::GetText(), KIGFX::VIEW::IsLayerVisible(), LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, LAYER_FP_REFERENCES, LAYER_FP_TEXT, LAYER_FP_VALUES, LAYER_LOCKED_ITEM_SHADOW, and BOARD_ITEM::m_layer.

Referenced by PCB_FIELD::ViewGetLOD().

◆ viewPrivData()

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

inlineinherited

Definition at line 148 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::draw(), KIGFX::VIEW::HasItem(), KIGFX::VIEW::Hide(), KIGFX::VIEW::invalidateItem(), KIGFX::VIEW::IsHiddenOnOverlay(), KIGFX::VIEW::IsVisible(), KIGFX::VIEW::UPDATE_COLOR_VISITOR::operator()(), KIGFX::VIEW::UPDATE_DEPTH_VISITOR::operator()(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), KIGFX::VIEW::RECACHE_ITEM_VISITOR::operator()(), KIGFX::VIEW::CLEAR_LAYER_CACHE_VISITOR::operator()(), KIGFX::VIEW::SetVisible(), KIGFX::VIEW::Update(), KIGFX::VIEW::updateItemColor(), KIGFX::VIEW::updateItemGeometry(), and KIGFX::VIEW::updateLayers().

◆ 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 PCB_GROUP, LIB_SYMBOL, SCH_SHEET, SCH_SYMBOL, SCH_TABLE, GBR_LAYOUT, GERBER_DRAW_ITEM, GERBER_FILE_IMAGE, FOOTPRINT, PCB_TABLE, PCB_TRACK, SCH_LABEL_BASE, and BOARD.

Definition at line 94 of file eda_item.cpp.

References EDA_ITEM::GetClass(), and EDA_ITEM::IsType().

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

◆ XorFlags()

void EDA_ITEM::XorFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 128 of file eda_item.h.

References EDA_ITEM::m_flags.

Referenced by EE_SELECTION_TOOL::selectMultiple().

Member Data Documentation

◆ m_arrowDirection

DIM_ARROW_DIRECTION PCB_DIMENSION_BASE::m_arrowDirection

protectedinherited

direction of dimension arrow.

Definition at line 359 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetArrowDirection(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetArrowDirection(), PCB_DIM_ALIGNED::updateGeometry(), and PCB_DIM_ORTHOGONAL::updateGeometry().

◆ m_arrowLength

int PCB_DIMENSION_BASE::m_arrowLength

protectedinherited

Length of arrow shapes.

Definition at line 365 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::drawAnArrow(), PCB_DIMENSION_BASE::GetArrowLength(), PCB_DIMENSION_BASE::operator==(), PCB_DIM_ALIGNED::PCB_DIM_ALIGNED(), PCB_DIM_ORTHOGONAL::PCB_DIM_ORTHOGONAL(), PCB_DIM_RADIAL(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetArrowLength(), PCB_DIMENSION_BASE::Similarity(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and updateGeometry().

◆ m_attributes

TEXT_ATTRIBUTES EDA_TEXT::m_attributes

privateinherited

Definition at line 458 of file eda_text.h.

Referenced by EDA_TEXT::Compare(), EDA_TEXT::EDA_TEXT(), EDA_TEXT::GetAttributes(), EDA_TEXT::GetFont(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetLineSpacing(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextAngleDegrees(), EDA_TEXT::GetTextColor(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), EDA_TEXT::GetVertJustify(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsKeepUpright(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), EDA_TEXT::IsVisible(), EDA_TEXT::operator=(), EDA_TEXT::SetAttributes(), EDA_TEXT::SetBold(), EDA_TEXT::SetBoldFlag(), EDA_TEXT::SetFont(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_TEXT::SetItalicFlag(), EDA_TEXT::SetKeepUpright(), EDA_TEXT::SetLineSpacing(), EDA_TEXT::SetMirrored(), EDA_TEXT::SetMultilineAllowed(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextColor(), EDA_TEXT::SetTextHeight(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), EDA_TEXT::SetTextWidth(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), EDA_TEXT::Similarity(), and EDA_TEXT::SwapAttributes().

◆ m_autoUnits

bool PCB_DIMENSION_BASE::m_autoUnits

protectedinherited

If true, follow the currently selected UI units.

Definition at line 357 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetUnitsMode(), PCB_DIMENSION_BASE::operator==(), PCB_DIMENSION_BASE::SetAutoUnits(), PCB_DIMENSION_BASE::SetUnitsMode(), and PCB_DIMENSION_BASE::Similarity().

◆ m_bounding_box_cache

BOX2I EDA_TEXT::m_bounding_box_cache

mutableprivateinherited

Definition at line 456 of file eda_text.h.

Referenced by EDA_TEXT::EDA_TEXT(), EDA_TEXT::GetTextBox(), and EDA_TEXT::operator=().

◆ m_bounding_box_cache_line

int EDA_TEXT::m_bounding_box_cache_line

mutableprivateinherited

Definition at line 455 of file eda_text.h.

Referenced by EDA_TEXT::EDA_TEXT(), and EDA_TEXT::GetTextBox().

◆ m_bounding_box_cache_pos

VECTOR2I EDA_TEXT::m_bounding_box_cache_pos

mutableprivateinherited

Definition at line 454 of file eda_text.h.

Referenced by EDA_TEXT::GetTextBox().

◆ m_bounding_box_cache_valid

bool EDA_TEXT::m_bounding_box_cache_valid

mutableprivateinherited

◆ m_end

VECTOR2I PCB_DIMENSION_BASE::m_end

protectedinherited

◆ m_extensionOffset

int PCB_DIMENSION_BASE::m_extensionOffset

protectedinherited

Distance from feature points to extension line start.

Definition at line 366 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetExtensionOffset(), PCB_DIMENSION_BASE::operator==(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetExtensionOffset(), PCB_DIMENSION_BASE::Similarity(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and PCB_DIM_LEADER::updateGeometry().

◆ m_flags

EDA_ITEM_FLAGS EDA_ITEM::m_flags

protectedinherited

Definition at line 499 of file eda_item.h.

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

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 169 of file view_item.h.

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

◆ m_forceVisible

bool EDA_ITEM::m_forceVisible

protectedinherited

Definition at line 501 of file eda_item.h.

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

◆ m_group

PCB_GROUP* BOARD_ITEM::m_group

protectedinherited

Definition at line 441 of file board_item.h.

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

◆ m_hyperlink

wxString EDA_TEXT::m_hyperlink

protectedinherited

A hyperlink URL.

If empty, this text object is not a hyperlink.

Definition at line 438 of file eda_text.h.

Referenced by SCH_TEXT::DoHypertextAction(), SCH_TEXTBOX::DoHypertextAction(), EDA_TEXT::GetHyperlink(), EDA_TEXT::HasHyperlink(), EDA_TEXT::RemoveHyperlink(), and EDA_TEXT::SetHyperlink().

◆ m_inClearRenderCache

bool PCB_DIMENSION_BASE::m_inClearRenderCache

protectedinherited

re-entrancy guard

Definition at line 378 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::ClearRenderCache().

◆ m_isBOARD_ITEM

bool KIGFX::VIEW_ITEM::m_isBOARD_ITEM

privateinherited

Definition at line 167 of file view_item.h.

◆ m_isKnockout

bool BOARD_ITEM::m_isKnockout

protectedinherited

Definition at line 437 of file board_item.h.

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

◆ m_isLocked

bool BOARD_ITEM::m_isLocked

protectedinherited

Definition at line 439 of file board_item.h.

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

◆ m_isSCH_ITEM

bool KIGFX::VIEW_ITEM::m_isSCH_ITEM

privateinherited

Definition at line 166 of file view_item.h.

◆ m_IuScale

std::reference_wrapper<const EDA_IU_SCALE> EDA_TEXT::m_IuScale

privateinherited

Definition at line 445 of file eda_text.h.

Referenced by EDA_TEXT::EDA_TEXT(), EDA_TEXT::Format(), EDA_TEXT::SetTextHeight(), EDA_TEXT::SetTextSize(), and EDA_TEXT::SetTextWidth().

◆ m_keepTextAligned

bool PCB_DIMENSION_BASE::m_keepTextAligned

protectedinherited

Calculate text orientation to match dimension.

Definition at line 368 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetKeepTextAligned(), PCB_DIMENSION_BASE::operator==(), PCB_DIM_LEADER::PCB_DIM_LEADER(), PCB_DIM_RADIAL(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetKeepTextAligned(), PCB_DIMENSION_BASE::Similarity(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_ORTHOGONAL::updateText(), and updateText().

◆ m_layer

PCB_LAYER_ID BOARD_ITEM::m_layer

protectedinherited

Definition at line 436 of file board_item.h.

Referenced by FOOTPRINT::FOOTPRINT(), PCB_VIA::GetDrillConstraint(), BOARD_ITEM::GetLayer(), PCB_SHAPE::GetLayer(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetLayerSet(), PCB_SHAPE::GetLayerSet(), PCB_TRACK::GetLayerSet(), PCB_TUNING_PATTERN::GetMsgPanelInfo(), PCB_REFERENCE_IMAGE::GetMsgPanelInfo(), PAD::GetPrincipalLayer(), PCB_TRACK::GetWidthConstraint(), PCB_VIA::GetWidthConstraint(), BOARD_ITEM::IsOnLayer(), PCB_SHAPE::IsOnLayer(), PCB_TRACK::IsOnLayer(), BOARD_ITEM::IsSideSpecific(), PCB_SHAPE::IsType(), PCB_ARC::operator==(), PCB_REFERENCE_IMAGE::operator==(), PCB_SHAPE::operator==(), PCB_TARGET::operator==(), PCB_TRACK::operator==(), PCB_VIA::operator==(), PCB_DIMENSION_BASE::PCB_DIMENSION_BASE(), PCB_TARGET::PCB_TARGET(), PCB_TUNING_PATTERN::recoverBaseline(), PCB_MARKER::SerializeToString(), BOARD_ITEM::SetLayer(), PCB_GENERATOR::SetLayer(), PCB_REFERENCE_IMAGE::Similarity(), PCB_TRACK::Similarity(), PCB_ARC::Similarity(), PCB_VIA::Similarity(), PCB_SHAPE::swapData(), PCB_TABLE::swapData(), PCB_REFERENCE_IMAGE::swapData(), BOARD_ITEM::ViewGetLayers(), FOOTPRINT::ViewGetLayers(), PCB_REFERENCE_IMAGE::ViewGetLayers(), PCB_SHAPE::ViewGetLayers(), PCB_TRACK::ViewGetLayers(), FOOTPRINT::ViewGetLOD(), PCB_REFERENCE_IMAGE::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), and PCB_TRACK::ViewGetLOD().

◆ m_leaderLength

int PCB_DIM_RADIAL::m_leaderLength

private

Definition at line 623 of file pcb_dimension.h.

Referenced by GetKnee(), GetLeaderLength(), PCB_DIM_RADIAL(), Serialize(), SetLeaderLength(), and updateGeometry().

◆ m_lineThickness

int PCB_DIMENSION_BASE::m_lineThickness

protectedinherited

Thickness used for all graphics in the dimension.

Definition at line 364 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetBoundingBox(), PCB_DIM_CENTER::GetBoundingBox(), PCB_DIMENSION_BASE::GetLineThickness(), PCB_DIMENSION_BASE::HitTest(), PCB_DIMENSION_BASE::operator==(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetLineThickness(), PCB_DIMENSION_BASE::Similarity(), and PCB_DIMENSION_BASE::TransformShapeToPolygon().

◆ m_measuredValue

int PCB_DIMENSION_BASE::m_measuredValue

protectedinherited

value of PCB dimensions

Definition at line 371 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetMeasuredValue(), PCB_DIMENSION_BASE::operator==(), PCB_DIMENSION_BASE::SetMeasuredValue(), PCB_DIMENSION_BASE::Similarity(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), and updateGeometry().

◆ m_overrideTextEnabled

bool PCB_DIMENSION_BASE::m_overrideTextEnabled

protectedinherited

Manually specify the displayed measurement value.

Definition at line 352 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetOverrideTextEnabled(), PCB_DIM_CENTER::PCB_DIM_CENTER(), PCB_DIM_LEADER::PCB_DIM_LEADER(), PCB_DIM_RADIAL(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetOverrideTextEnabled(), and PCB_DIMENSION_BASE::updateText().

◆ m_parent

EDA_ITEM* EDA_ITEM::m_parent

protectedinherited

Linked list: Link (parent struct)

Definition at line 500 of file eda_item.h.

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

◆ m_pos

VECTOR2I EDA_TEXT::m_pos

privateinherited

Definition at line 459 of file eda_text.h.

Referenced by EDA_TEXT::Compare(), EDA_TEXT::EDA_TEXT(), EDA_TEXT::GetTextPos(), EDA_TEXT::Offset(), EDA_TEXT::operator=(), EDA_TEXT::SetAttributes(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextX(), EDA_TEXT::SetTextY(), EDA_TEXT::Similarity(), and EDA_TEXT::SwapAttributes().

◆ m_precision

DIM_PRECISION PCB_DIMENSION_BASE::m_precision

protectedinherited

Number of digits to display after decimal.

Definition at line 360 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetPrecision(), PCB_DIMENSION_BASE::GetValueText(), PCB_DIMENSION_BASE::operator==(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetPrecision(), and PCB_DIMENSION_BASE::Similarity().

◆ m_prefix

wxString PCB_DIMENSION_BASE::m_prefix

protectedinherited

String prepended to the value.

Definition at line 354 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetPrefix(), PCB_DIM_RADIAL(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetPrefix(), and PCB_DIMENSION_BASE::updateText().

◆ m_render_cache

std::vector<std::unique_ptr<KIFONT::GLYPH> > EDA_TEXT::m_render_cache

mutableprivateinherited

Definition at line 451 of file eda_text.h.

Referenced by EDA_TEXT::AddRenderCacheGlyph(), EDA_TEXT::ClearRenderCache(), EDA_TEXT::EDA_TEXT(), EDA_TEXT::GetRenderCache(), EDA_TEXT::Offset(), EDA_TEXT::operator=(), and EDA_TEXT::SetupRenderCache().

◆ m_render_cache_angle

EDA_ANGLE EDA_TEXT::m_render_cache_angle

mutableprivateinherited

Definition at line 449 of file eda_text.h.

Referenced by EDA_TEXT::EDA_TEXT(), EDA_TEXT::GetRenderCache(), EDA_TEXT::operator=(), and EDA_TEXT::SetupRenderCache().

◆ m_render_cache_font

const KIFONT::FONT* EDA_TEXT::m_render_cache_font

mutableprivateinherited

Definition at line 448 of file eda_text.h.

Referenced by EDA_TEXT::EDA_TEXT(), EDA_TEXT::GetRenderCache(), EDA_TEXT::operator=(), and EDA_TEXT::SetupRenderCache().

◆ m_render_cache_offset

VECTOR2I EDA_TEXT::m_render_cache_offset

mutableprivateinherited

Definition at line 450 of file eda_text.h.

Referenced by EDA_TEXT::EDA_TEXT(), EDA_TEXT::GetRenderCache(), EDA_TEXT::operator=(), and EDA_TEXT::SetupRenderCache().

◆ m_render_cache_text

wxString EDA_TEXT::m_render_cache_text

mutableprivateinherited

Definition at line 447 of file eda_text.h.

Referenced by EDA_TEXT::EDA_TEXT(), EDA_TEXT::GetRenderCache(), EDA_TEXT::operator=(), and EDA_TEXT::SetupRenderCache().

◆ m_shapes

std::vector<std::shared_ptr<SHAPE> > PCB_DIMENSION_BASE::m_shapes

protectedinherited

Definition at line 376 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::addShape(), PCB_DIMENSION_BASE::drawAnArrow(), PCB_DIMENSION_BASE::GetShapes(), PCB_DIM_ALIGNED::swapData(), PCB_DIM_ORTHOGONAL::swapData(), swapData(), PCB_DIM_LEADER::swapData(), PCB_DIMENSION_BASE::TransformShapeToPolygon(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), updateGeometry(), PCB_DIM_LEADER::updateGeometry(), and PCB_DIM_CENTER::updateGeometry().

◆ m_shown_text

wxString EDA_TEXT::m_shown_text

privateinherited

Definition at line 442 of file eda_text.h.

Referenced by EDA_TEXT::cacheShownText(), EDA_TEXT::EDA_TEXT(), EDA_TEXT::GetShownText(), and EDA_TEXT::operator=().

◆ m_shown_text_has_text_var_refs

bool EDA_TEXT::m_shown_text_has_text_var_refs

privateinherited

Definition at line 443 of file eda_text.h.

Referenced by EDA_TEXT::cacheShownText(), EDA_TEXT::EDA_TEXT(), EDA_TEXT::HasTextVars(), and EDA_TEXT::operator=().

◆ m_start

◆ m_structType

KICAD_T EDA_ITEM::m_structType

privateinherited

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

See comment near SetType() regarding virtual functions.

Definition at line 496 of file eda_item.h.

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

◆ m_suffix

wxString PCB_DIMENSION_BASE::m_suffix

protectedinherited

String appended to the value.

Definition at line 355 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetSuffix(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetSuffix(), and PCB_DIMENSION_BASE::updateText().

◆ m_suppressZeroes

bool PCB_DIMENSION_BASE::m_suppressZeroes

protectedinherited

Suppress trailing zeroes.

Definition at line 361 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetSuppressZeroes(), PCB_DIMENSION_BASE::GetValueText(), PCB_DIMENSION_BASE::operator==(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetSuppressZeroes(), and PCB_DIMENSION_BASE::Similarity().

◆ m_text

wxString EDA_TEXT::m_text

privateinherited

Definition at line 441 of file eda_text.h.

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

◆ m_textPosition

DIM_TEXT_POSITION PCB_DIMENSION_BASE::m_textPosition

protectedinherited

How to position the text.

Definition at line 367 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetTextPositionMode(), PCB_DIMENSION_BASE::operator==(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetTextPositionMode(), PCB_DIMENSION_BASE::Similarity(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ m_units

EDA_UNITS PCB_DIMENSION_BASE::m_units

protectedinherited

0 = inches, 1 = mm

Definition at line 356 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetUnits(), PCB_DIMENSION_BASE::GetUnitsMode(), PCB_DIMENSION_BASE::GetValueText(), PCB_DIMENSION_BASE::operator==(), PCB_DIMENSION_BASE::SetUnits(), PCB_DIMENSION_BASE::SetUnitsMode(), PCB_DIMENSION_BASE::Similarity(), and PCB_DIMENSION_BASE::updateText().

◆ m_unitsFormat

DIM_UNITS_FORMAT PCB_DIMENSION_BASE::m_unitsFormat

protectedinherited

How to render the units suffix.

Definition at line 358 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetUnitsFormat(), PCB_DIMENSION_BASE::operator==(), PCB_DIM_CENTER::PCB_DIM_CENTER(), PCB_DIM_LEADER::PCB_DIM_LEADER(), PCB_DIM_RADIAL(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetUnitsFormat(), PCB_DIMENSION_BASE::Similarity(), and PCB_DIMENSION_BASE::updateText().

◆ m_Uuid

const KIID EDA_ITEM::m_Uuid

inherited

Definition at line 489 of file eda_item.h.

◆ m_valueString

wxString PCB_DIMENSION_BASE::m_valueString

protectedinherited

Displayed value when m_overrideValue = true.

Definition at line 353 of file pcb_dimension.h.

Referenced by PCB_DIMENSION_BASE::GetOverrideText(), PCB_DIMENSION_BASE::Serialize(), PCB_DIMENSION_BASE::SetOverrideText(), and PCB_DIMENSION_BASE::updateText().

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 168 of file view_item.h.

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

◆ ZeroOffset

VECTOR2I BOARD_ITEM::ZeroOffset

staticinherited

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

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

Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

Constructor & Destructor Documentation

◆ PCB_DIM_RADIAL()

Member Function Documentation

◆ AddRenderCacheGlyph()

◆ addShape()

◆ BoardCopperLayerCount()

◆ BoardLayerCount()

◆ BoardLayerSet()

◆ buildBoundingHull()

◆ cacheShownText()

◆ ChangeArrowDirection()

◆ ChangeKeepTextAligned()

◆ ChangeLeaderLength()

◆ ChangeOverrideText()

◆ ChangePrecision()

◆ ChangePrefix()

◆ ChangeSuffix()

◆ ChangeSuppressZeroes()

◆ ChangeTextAngleDegrees()

◆ ChangeUnitsFormat()

◆ ChangeUnitsMode()

◆ ClassOf()

◆ ClearBoundingBoxCache()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearRenderCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ Clone()

◆ Compare()

◆ CopyText()

◆ DeleteStructure()

◆ Deserialize()

◆ drawAnArrow()

◆ Duplicate()

◆ Empty()

◆ Flip()

◆ FlipHJustify()

◆ Format()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetArrowDirection()

◆ GetArrowLength()

◆ GetAttributes()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ getDrawFont()

◆ GetDrawPos()

◆ GetDrawRotation()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveShape()

◆ GetEffectiveTextPenWidth()

◆ GetEffectiveTextShape()

◆ GetEmbeddedFiles()

◆ GetEnd()

◆ GetExtensionOffset()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFont()

◆ GetFontIndex()

◆ GetFontMetrics()

◆ getFontMetrics()

◆ GetFontName()