#include <pcb_text.h>

Inheritance diagram for PCB_TEXT:

Public Member Functions
	PCB_TEXT (BOARD_ITEM *parent)

	~PCB_TEXT ()

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

wxString	GetShownText (int aDepth=0, bool aAllowExtraText=true) const override
	Return the string actually shown after processing of the base text. More...

void	SetVisible (bool aVisible) override
	PCB_TEXTs are always visible: More...

bool	IsVisible () const override

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

virtual VECTOR2I	GetPosition () const override

virtual void	SetPosition (const VECTOR2I &aPos) override

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

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

void	Mirror (const VECTOR2I &aCentre, bool aMirrorAroundXAxis)

void	Flip (const VECTOR2I &aCentre, bool aFlipLeftRight) override
	Flip this object, i.e. More...

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

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

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

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

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

wxString	GetClass () const override
	Return the class name. More...

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

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

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

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

BITMAPS	GetMenuImage () const override

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

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

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

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

void	SetX (int aX)

void	SetY (int aY)

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

virtual bool	IsOnCopperLayer () const

virtual bool	HasHole () const

virtual bool	IsTented () const

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

BOARD_ITEM_CONTAINER *	GetParent () const

BOARD_ITEM_CONTAINER *	GetParentFootprint () const

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

virtual STROKE_PARAMS	GetStroke () const

virtual void	SetStroke (const STROKE_PARAMS &aStroke)

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

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

virtual void	SetLayerSet (LSET aLayers)

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

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

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

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

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

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

virtual BOARD *	GetBoard ()

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

virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

KICAD_T	Type () const
	Returns the type of object. More...

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

int	GetState (EDA_ITEM_FLAGS type) const

void	SetState (EDA_ITEM_FLAGS type, bool state)

EDA_ITEM_FLAGS	GetStatus () const

void	SetStatus (EDA_ITEM_FLAGS aStatus)

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

void	ClearTempFlags ()

void	ClearEditFlags ()

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

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

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

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

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

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

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

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

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

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

VIEW_ITEM_DATA *	viewPrivData () const

void	ClearViewPrivData ()

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

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

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

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

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

virtual void	SetText (const wxString &aText)

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

int	GetTextThickness () const

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

virtual void	SetTextAngle (const EDA_ANGLE &aAngle)

const EDA_ANGLE &	GetTextAngle () const

void	SetTextAngleDegrees (double aOrientation)

double	GetTextAngleDegrees () const

void	SetItalic (bool aItalic)

bool	IsItalic () const

void	SetBold (bool aBold)

bool	IsBold () 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	SetAttributes (const EDA_TEXT &aSrc)
	Set the text attributes from another instance. More...

void	SetAttributes (const TEXT_ATTRIBUTES &aTextAttrs)

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

void	SwapText (EDA_TEXT &aTradingPartner)

void	CopyText (const EDA_TEXT &aSrc)

const TEXT_ATTRIBUTES &	GetAttributes () const

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

bool	IsDefaultFormatting () const

void	SetFont (KIFONT::FONT *aFont)

KIFONT::FONT *	GetFont () const

wxString	GetFontName () const

void	SetLineSpacing (double aLineSpacing)

double	GetLineSpacing () const

void	SetTextSize (const VECTOR2I &aNewSize)

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

void	TransformBoundingBoxToPolygon (SHAPE_POLY_SET *aBuffer, int aClearance) const
	Convert the text bounding box to a rectangular polygon depending on the text orientation, the bounding box is not always horizontal or vertical. More...

std::shared_ptr< SHAPE_COMPOUND >	GetEffectiveTextShape (bool aTriangulate=true, bool aUseTextRotation=true) const
	build a list of segments (SHAPE_SEGMENT) to describe a text shape. More...

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

int	GetInterline () const
	Return the distance between two lines of text. More...

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

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

virtual EDA_ANGLE	GetDrawRotation () const

virtual VECTOR2I	GetDrawPos () const

virtual void	ClearRenderCache ()

virtual void	ClearBoundingBoxCache ()

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

void	SetupRenderCache (const wxString &aResolvedText, const EDA_ANGLE &aAngle)

void	AddRenderCacheGlyph (const SHAPE_POLY_SET &aPoly)

int	Compare (const EDA_TEXT *aOther) 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. More...

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

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

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

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

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

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

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

Protected Member Functions
virtual void	swapData (BOARD_ITEM *aImage) override

int	getKnockoutMargin () const

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

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

virtual KIFONT::FONT *	getDrawFont () const

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

Protected Attributes
PCB_LAYER_ID	m_layer

bool	m_isKnockout

bool	m_isLocked

PCB_GROUP *	m_group

EDA_ITEM_FLAGS	m_status

EDA_ITEM *	m_parent
	Linked list: Link (parent struct) More...

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

wxString	m_hyperlink
	A hyperlink URL. More...

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

VIEW_ITEM_DATA *	m_viewPrivData

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

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

bool	m_bounding_box_cache_inverted

BOX2I	m_bounding_box_cache

TEXT_ATTRIBUTES	m_attributes

VECTOR2I	m_pos

Detailed Description

Definition at line 36 of file pcb_text.h.

Constructor & Destructor Documentation

◆ PCB_TEXT()

PCB_TEXT::PCB_TEXT ( BOARD_ITEM * parent )

Definition at line 43 of file pcb_text.cpp.

 :
 BOARD_ITEM( parent, PCB_TEXT_T ),
 EDA_TEXT( pcbIUScale )
{
 SetMultilineAllowed( true );
}

References EDA_TEXT::SetMultilineAllowed().

Referenced by Clone().

◆ ~PCB_TEXT()

PCB_TEXT::~PCB_TEXT ( )

Definition at line 51 of file pcb_text.cpp.

52{

53}

Member Function Documentation

◆ AddRenderCacheGlyph()

void EDA_TEXT::AddRenderCacheGlyph ( const SHAPE_POLY_SET & aPoly )

inherited

Definition at line 491 of file eda_text.cpp.

{
 m_render_cache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( aPoly ) );
}

References EDA_TEXT::m_render_cache.

◆ cacheShownText()

void EDA_TEXT::cacheShownText ( )

protectedinherited

Definition at line 408 of file eda_text.cpp.

{
 if( m_text.IsEmpty() )
 {
 m_shown_text = wxEmptyString;
 m_shown_text_has_text_var_refs = false;
 }
 else
 {
 m_shown_text = UnescapeString( m_text );
 m_shown_text_has_text_var_refs = m_shown_text.Contains( wxT( "${" ) );
 }
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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 EDA_TEXT::EDA_TEXT(), EDA_TEXT::Replace(), and EDA_TEXT::SetText().

◆ ClassOf()

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

inlinestatic

Definition at line 46 of file pcb_text.h.

 {
 return aItem && PCB_TEXT_T == aItem->Type();
 }

References PCB_TEXT_T, and EDA_ITEM::Type().

Referenced by TEXT_SEARCH_HANDLER::GetResultCell().

◆ ClearBoundingBoxCache()

void EDA_TEXT::ClearBoundingBoxCache ( )

virtualinherited

Definition at line 444 of file eda_text.cpp.

{
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::m_bounding_box_cache_valid.

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

◆ ClearBrightened()

void EDA_ITEM::ClearBrightened ( )

inlineinherited

Definition at line 119 of file eda_item.h.

119{ ClearFlags( BRIGHTENED ); }

EDA_ITEM::ClearFlags

void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)

Definition: eda_item.h:141

BRIGHTENED

#define BRIGHTENED

item is drawn with a bright contour

Definition: eda_item_flags.h:65

References BRIGHTENED, and EDA_ITEM::ClearFlags().

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

◆ ClearEditFlags()

void EDA_ITEM::ClearEditFlags ( )

inlineinherited

Definition at line 158 of file eda_item.h.

 {
 ClearFlags( GetEditFlags() );
 }

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

Referenced by BOARD::Add(), FOOTPRINT::Add(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SCH_LINE_WIRE_BUS_TOOL::finishSegments(), PL_DRAWING_TOOLS::PlaceItem(), SCH_DRAWING_TOOLS::PlaceSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), and SYMBOL_EDITOR_DRAWING_TOOLS::TwoClickPlace().

◆ ClearFlags()

void EDA_ITEM::ClearFlags ( EDA_ITEM_FLAGS aMask = EDA_ITEM_ALL_FLAGS )

inlineinherited

Definition at line 141 of file eda_item.h.

141{ m_flags &= ~aMask; }

EDA_ITEM::m_flags

EDA_ITEM_FLAGS m_flags

Definition: eda_item.h:498

References EDA_ITEM::m_flags.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), PNS_KICAD_IFACE::AddItem(), SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_MOVE_TOOL::AlignElements(), SCH_EDIT_TOOL::BreakWire(), FOOTPRINT::BuildCourtyardCaches(), EDA_ITEM::ClearBrightened(), EDA_ITEM::ClearEditFlags(), EDA_ITEM::ClearSelected(), EDA_ITEM::ClearTempFlags(), SCH_EDIT_FRAME::ConvertPart(), SYMBOL_EDITOR_EDIT_TOOL::Copy(), 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(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_SELECTION_TOOL::ExitGroup(), SYMBOL_EDIT_FRAME::GetSymbolFromRedoList(), SYMBOL_EDIT_FRAME::GetSymbolFromUndoList(), 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(), PCB_BASE_FRAME::PlaceFootprint(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), BOARD_COMMIT::Push(), PCB_SELECTION_TOOL::RebuildSelection(), PAD_TOOL::RecombinePad(), SCH_EDIT_TOOL::RepeatDrawItem(), SYMBOL_EDIT_FRAME::RollbackSymbolFromUndo(), DRC_TEST_PROVIDER_DISALLOW::Run(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), SCH_SEXPR_PLUGIN_CACHE::savePin(), EE_SELECTION_TOOL::selectMultiple(), SCH_EDIT_FRAME::SelectUnit(), EDA_ITEM::SetIsShownAsBitmap(), BOARD_COMMIT::Stage(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and EE_SELECTION_TOOL::unhighlight().

◆ ClearRenderCache()

void EDA_TEXT::ClearRenderCache ( )

virtualinherited

◆ ClearSelected()

void EDA_ITEM::ClearSelected ( )

inlineinherited

Definition at line 118 of file eda_item.h.

118{ ClearFlags( SELECTED ); }

SELECTED

#define SELECTED

Item was manually selected by the user.

Definition: eda_item_flags.h:47

References EDA_ITEM::ClearFlags(), and SELECTED.

Referenced by PCB_POINT_EDITOR::addCorner(), EDIT_TOOL::Duplicate(), ARRAY_CREATOR::Invoke(), LIB_SYMBOL::LIB_SYMBOL(), EE_TOOL_BASE< T >::saveCopyInUndoList(), SCH_DRAWING_TOOLS::TwoClickPlace(), EE_SELECTION_TOOL::unhighlight(), PL_SELECTION_TOOL::unhighlight(), PCB_SELECTION_TOOL::unhighlightInternal(), and GERBVIEW_SELECTION_TOOL::unselectVisually().

◆ ClearTempFlags()

void EDA_ITEM::ClearTempFlags ( )

inlineinherited

Definition at line 153 of file eda_item.h.

 {
 ClearFlags( CANDIDATE | SELECTED_BY_DRAG | IS_LINKED | SKIP_STRUCT );
 }

References CANDIDATE, EDA_ITEM::ClearFlags(), IS_LINKED, SELECTED_BY_DRAG, and SKIP_STRUCT.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles(), and SCH_EDIT_FRAME::PutDataInPreviousState().

◆ ClearViewPrivData()

void KIGFX::VIEW_ITEM::ClearViewPrivData ( )

inlineinherited

Definition at line 143 of file view_item.h.

 {
 m_viewPrivData = nullptr;
 }

References KIGFX::VIEW_ITEM::m_viewPrivData.

Referenced by KIGFX::VIEW::OnDestroy().

◆ Clone()

EDA_ITEM * PCB_TEXT::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 252 of file pcb_text.cpp.

{
 return new PCB_TEXT( *this );
}

References PCB_TEXT().

◆ Compare()

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

inherited

Definition at line 911 of file eda_text.cpp.

{
#define EPSILON 2 // Should be enough for rounding errors on calculated items
 
#define TEST( a, b ) { if( a != b ) return a - b; }
#define TEST_E( a, b ) { if( abs( a - b ) > EPSILON ) return a - b; }
#define TEST_PT( a, b ) { TEST_E( a.x, b.x ); TEST_E( a.y, b.y ); }
 
 TEST_PT( m_pos, aOther->m_pos );
 
 TEST_PT( m_attributes.m_Size, aOther->m_attributes.m_Size );
 TEST_E( m_attributes.m_StrokeWidth, aOther->m_attributes.m_StrokeWidth );
 TEST( m_attributes.m_Angle.AsDegrees(), aOther->m_attributes.m_Angle.AsDegrees() );
 TEST( m_attributes.m_LineSpacing, aOther->m_attributes.m_LineSpacing );
 
 TEST( m_attributes.m_Halign, aOther->m_attributes.m_Halign );
 TEST( m_attributes.m_Valign, aOther->m_attributes.m_Valign );
 TEST( m_attributes.m_Italic, aOther->m_attributes.m_Italic );
 TEST( m_attributes.m_Bold, aOther->m_attributes.m_Bold );
 TEST( m_attributes.m_Underlined, aOther->m_attributes.m_Underlined );
 TEST( m_attributes.m_Visible, aOther->m_attributes.m_Visible );
 TEST( m_attributes.m_Mirrored, aOther->m_attributes.m_Mirrored );
 TEST( m_attributes.m_Multiline, aOther->m_attributes.m_Multiline );
 TEST( m_attributes.m_KeepUpright, aOther->m_attributes.m_KeepUpright );
 
 int val = GetFontName().Cmp( aOther->GetFontName() );
 
 if( val != 0 )
 return val;
 
 return m_text.Cmp( aOther->m_text );
}

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

Definition at line 174 of file eda_text.cpp.

{
 m_text = aSrc.m_text;
 m_shown_text = aSrc.m_shown_text;
 m_shown_text_has_text_var_refs = aSrc.m_shown_text_has_text_var_refs;
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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, and EDA_TEXT::m_text.

Referenced by LIB_FIELD::Copy(), and CLIPBOARD_IO::SaveSelection().

◆ DeleteStructure()

void BOARD_ITEM::DeleteStructure ( )

inherited

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

Definition at line 150 of file board_item.cpp.

{
 BOARD_ITEM_CONTAINER* parent = GetParent();
 
 if( parent )
 parent->Remove( this );
 
 delete this;
}

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

Referenced by DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow().

◆ Duplicate()

BOARD_ITEM * BOARD_ITEM::Duplicate ( ) const

virtualinherited

Create a copy of this BOARD_ITEM.

Reimplemented in FOOTPRINT.

Definition at line 184 of file board_item.cpp.

{
 BOARD_ITEM* dupe = static_cast<BOARD_ITEM*>( Clone() );
 const_cast<KIID&>( dupe->m_Uuid ) = KIID();
 
 if( dupe->GetParentGroup() )
 dupe->GetParentGroup()->AddItem( dupe );
 
 return static_cast<BOARD_ITEM*>( dupe );
}

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), PCB_GROUP::DeepDuplicate(), KIGFX::PCB_PAINTER::draw(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), FOOTPRINT::Duplicate(), EDIT_TOOL::Duplicate(), FOOTPRINT::DuplicateItem(), and ARRAY_CREATOR::Invoke().

◆ Empty()

void EDA_TEXT::Empty ( )

inherited

Definition at line 400 of file eda_text.cpp.

{
 m_text.Empty();
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by SCH_LEGACY_PLUGIN_CACHE::LoadPart().

◆ Flip()

void PCB_TEXT::Flip	(	const VECTOR2I &	aCentre,
		bool	aFlipLeftRight
	)

overridevirtual

Flip this object, i.e.

change the board side for this object.

Parameters

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

Reimplemented from BOARD_ITEM.

Definition at line 218 of file pcb_text.cpp.

{
 if( aFlipLeftRight )
 {
 SetTextX( MIRRORVAL( GetTextPos().x, aCentre.x ) );
 SetTextAngle( -GetTextAngle() );
 }
 else
 {
 SetTextY( MIRRORVAL( GetTextPos().y, aCentre.y ) );
 SetTextAngle( ANGLE_180 - GetTextAngle() );
 }
 
 SetLayer( FlipLayer( GetLayer(), GetBoard()->GetCopperLayerCount() ) );
 
 if( ( GetLayerSet() & LSET::SideSpecificMask() ).any() )
 SetMirrored( !IsMirrored() );
}

References ANGLE_180, FlipLayer(), BOARD_ITEM::GetBoard(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetLayerSet(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_TEXT::IsMirrored(), MIRRORVAL(), BOARD_ITEM::SetLayer(), EDA_TEXT::SetMirrored(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextX(), EDA_TEXT::SetTextY(), LSET::SideSpecificMask(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText().

◆ Format()

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

virtualinherited

Output the object to aFormatter in s-expression form.

Parameters

aFormatter	The OUTPUTFORMATTER object to write to.
aNestLevel	The indentation next level.
aControlBits	The control bit definition for object specific formatting.

Exceptions

IO_ERROR on write error.

Definition at line 781 of file eda_text.cpp.

{
 aFormatter->Print( aNestLevel + 1, "(effects" );
 
 aFormatter->Print( 0, " (font" );
 
 if( GetFont() && !GetFont()->GetName().IsEmpty() )
 aFormatter->Print( 0, " (face \"%s\")", GetFont()->NameAsToken() );
 
 // Text size
 aFormatter->Print( 0, " (size %s %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( m_IuScale, GetTextHeight() ).c_str(),
 EDA_UNIT_UTILS::FormatInternalUnits( m_IuScale, GetTextWidth() ).c_str() );
 
 if( GetLineSpacing() != 1.0 )
 {
 aFormatter->Print( 0, " (line_spacing %s)",
 FormatDouble2Str( GetLineSpacing() ).c_str() );
 }
 
 if( GetTextThickness() )
 {
 aFormatter->Print( 0, " (thickness %s)",
 EDA_UNIT_UTILS::FormatInternalUnits( m_IuScale, GetTextThickness() ).c_str() );
 }
 
 if( IsBold() )
 aFormatter->Print( 0, " bold" );
 
 if( IsItalic() )
 aFormatter->Print( 0, " italic" );
 
 if( GetTextColor() != COLOR4D::UNSPECIFIED )
 {
 aFormatter->Print( 0, " (color %d %d %d %s)",
 KiROUND( GetTextColor().r * 255.0 ),
 KiROUND( GetTextColor().g * 255.0 ),
 KiROUND( GetTextColor().b * 255.0 ),
 FormatDouble2Str( GetTextColor().a ).c_str() );
 }
 
 aFormatter->Print( 0, ")"); // (font
 
 if( IsMirrored() || GetHorizJustify() != GR_TEXT_H_ALIGN_CENTER
 || GetVertJustify() != GR_TEXT_V_ALIGN_CENTER )
 {
 aFormatter->Print( 0, " (justify");
 
 if( GetHorizJustify() != GR_TEXT_H_ALIGN_CENTER )
 aFormatter->Print( 0, GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT ? " left" : " right" );
 
 if( GetVertJustify() != GR_TEXT_V_ALIGN_CENTER )
 aFormatter->Print( 0, GetVertJustify() == GR_TEXT_V_ALIGN_TOP ? " top" : " bottom" );
 
 if( IsMirrored() )
 aFormatter->Print( 0, " mirror" );
 
 aFormatter->Print( 0, ")" ); // (justify
 }
 
 if( !( aControlBits & CTL_OMIT_HIDE ) && !IsVisible() )
 aFormatter->Print( 0, " hide" );
 
 if( HasHyperlink() )
 {
 aFormatter->Print( 0, " (href %s)", aFormatter->Quotew( GetHyperlink() ).c_str() );
 }
 
 aFormatter->Print( 0, ")\n" ); // (effects
}

References CTL_OMIT_HIDE, 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_SEXPR_PLUGIN_CACHE::saveField(), and SCH_SEXPR_PLUGIN::saveField().

◆ Get() [1/3]

template<typename T >

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

inlineinherited

Definition at line 104 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 std::optional<T> ret;
 
 if( prop )
 {
 const void* object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 ret = prop->get<T>( object );
 }
 
 return ret;
 }

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 84 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 return object ? aProperty->getter( object ) : wxAny();
 }

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(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PROPERTIES_PANEL::getItemValue(), PCB_EXPR_VAR_REF::GetValue(), and PAD_DESC::PAD_DESC().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 const void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( !object )
 throw std::runtime_error( "Could not cast INSPECTABLE to the requested type" );
 
 return aProperty->get<T>( object );
 }

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

◆ GetAttributes()

const TEXT_ATTRIBUTES & EDA_TEXT::GetAttributes ( ) const

inlineinherited

Definition at line 172 of file eda_text.h.

172{ return m_attributes; }

References EDA_TEXT::m_attributes.

Referenced by BOARD_ADAPTER::addText(), KIGFX::DS_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), EDA_TEXT::GetEffectiveTextShape(), EDA_TEXT::GetRenderCache(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), PNS_KICAD_IFACE_BASE::syncTextItem(), FP_TEXT::TransformTextToPolySet(), FP_TEXTBOX::TransformTextToPolySet(), TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ GetBoard() [1/2]

BOARD * BOARD_ITEM::GetBoard ( )

virtualinherited

Definition at line 57 of file board_item.cpp.

{
 if( Type() == PCB_T )
 return static_cast<BOARD*>( this );
 
 BOARD_ITEM* parent = GetParent();
 
 if( parent )
 return parent->GetBoard();
 
 return nullptr;
}

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

{
 if( Type() == PCB_T )
 return static_cast<const BOARD*>( this );
 
 BOARD_ITEM* parent = GetParent();
 
 if( parent )
 return parent->GetBoard();
 
 return nullptr;
}

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

Referenced by BOARD_ADAPTER::addShape(), FOOTPRINT::BuildCourtyardCaches(), PAD::BuildEffectivePolygon(), PAD::BuildEffectiveShapes(), ZONE::BuildSmoothedPoly(), ZONE::CacheBoundingBox(), collidesWithArea(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), enclosedByAreaFunc(), existsOnLayerFunc(), PCB_VIA::FlashLayer(), PAD::FlashLayer(), FP_SHAPE::Flip(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_DIMENSION_BASE::Flip(), PCB_SHAPE::Flip(), PCB_TARGET::Flip(), Flip(), PCB_TEXTBOX::Flip(), PCB_TRACK::Flip(), PCB_ARC::Flip(), PCB_VIA::Flip(), ZONE::Flip(), PCB_PLUGIN::format(), fromToFunc(), BOARD_ITEM::GetBoard(), PCB_EXPR_CONTEXT::GetBoard(), NETINFO_ITEM::GetBoundingBox(), ZONE::GetBoundingBox(), FOOTPRINT::GetBoundingBox(), FOOTPRINT::GetBoundingHull(), FOOTPRINT::GetCourtyard(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), FP_TEXT::GetEffectiveShape(), GetEffectiveShape(), getFieldFunc(), ZONE::GetInteractingZones(), ZONE::GetItemDescription(), BOARD_ITEM::GetLayerName(), PCB_VIA::GetMinAnnulus(), NETINFO_ITEM::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), BOARD_CONNECTED_ITEM::GetNetnameMsg(), BOARD_CONNECTED_ITEM::GetOwnClearance(), PAD::GetOwnClearance(), PCB_MARKER::GetSeverity(), PAD::GetSolderMaskExpansion(), PCB_VIA::GetSolderMaskExpansion(), PAD::GetSolderPasteMargin(), BOARD::GetTrackLength(), PCB_TRACK::GetWidthConstraint(), inDiffPairFunc(), ROUTER_TOOL::Init(), intersectsAreaFunc(), intersectsBackCourtyardFunc(), intersectsCourtyardFunc(), intersectsFrontCourtyardFunc(), BOARD_ITEM::IsLocked(), PCB_VIA::IsTented(), BOARD_ITEM::layerMaskDescribe(), PCB_VIA::layerMaskDescribe(), PAD::MergePrimitivesAsPolygon(), ZONE::Move(), DIALOG_TEXTBOX_PROPERTIES::onBorderChecked(), EAGLE_PLUGIN::packageWire(), padsNeedUpdate(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), BOARD::ResolveDRCExclusions(), FOOTPRINT::ResolveTextVar(), BOARD_CONNECTED_ITEM::SetNetCode(), TEARDROP_DIALOG::TEARDROP_DIALOG(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataToWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataToWindow(), ZONE::TransformSmoothedOutlineToPolygon(), BOARD::UpdateRatsnestExclusions(), FOOTPRINT::ViewBBox(), PAD::ViewBBox(), PCB_TRACK::ViewBBox(), PAD::ViewGetLOD(), PCB_BITMAP::ViewGetLOD(), PCB_VIA::ViewGetLOD(), FOOTPRINT::~FOOTPRINT(), and ZONE::~ZONE().

◆ GetBoundingBox()

const BOX2I PCB_TEXT::GetBoundingBox ( ) const

overridevirtual

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

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

Reimplemented from EDA_ITEM.

Definition at line 141 of file pcb_text.cpp.

{
 BOX2I rect = GetTextBox();
 
 if( IsKnockout() )
 rect.Inflate( getKnockoutMargin() );
 
 if( !GetTextAngle().IsZero() )
 rect = rect.GetBoundingBoxRotated( GetTextPos(), GetTextAngle() );
 
 return rect;
}

References BOX2< Vec >::GetBoundingBoxRotated(), getKnockoutMargin(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextPos(), BOX2< Vec >::Inflate(), and BOARD_ITEM::IsKnockout().

Referenced by DRAWING_TOOL::DrawBoardCharacteristics(), and TextHitTest().

◆ 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 PAD, PCB_MARKER, PCB_SHAPE, and PCB_ARC.

Definition at line 93 of file board_item.h.

 {
 return GetBoundingBox().GetCenter();
 }

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

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

◆ GetClass()

wxString PCB_TEXT::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Implements EDA_ITEM.

Definition at line 112 of file pcb_text.h.

 {
 return wxT( "PCB_TEXT" );
 }

◆ getDrawFont()

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

protectedvirtualinherited

Reimplemented in LIB_FIELD, LIB_TEXT, LIB_TEXTBOX, SCH_FIELD, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 426 of file eda_text.cpp.

{
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( wxEmptyString, IsBold(), IsItalic() );
 
 return font;
}

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

Referenced by EDA_TEXT::GetEffectiveTextShape(), EDA_TEXT::GetInterline(), EDA_TEXT::GetRenderCache(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), EDA_TEXT::TransformBoundingBoxToPolygon(), FP_TEXT::TransformTextToPolySet(), FP_TEXTBOX::TransformTextToPolySet(), TransformTextToPolySet(), and PCB_TEXTBOX::TransformTextToPolySet().

◆ GetDrawPos()

virtual VECTOR2I EDA_TEXT::GetDrawPos ( ) const

inlinevirtualinherited

Reimplemented in LIB_TEXTBOX, SCH_TEXTBOX, FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 318 of file eda_text.h.

318{ return GetTextPos(); }

References EDA_TEXT::GetTextPos().

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT::GetEffectiveTextShape(), EDA_TEXT::GetLinePositions(), EDA_TEXT::GetRenderCache(), EDA_TEXT::GetTextBox(), BRDITEMS_PLOTTER::PlotPcbText(), EDA_TEXT::Print(), EDA_TEXT::TextHitTest(), and EDA_TEXT::TransformBoundingBoxToPolygon().

◆ GetDrawRotation()

virtual EDA_ANGLE EDA_TEXT::GetDrawRotation ( ) const

inlinevirtualinherited

◆ GetEditFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetEditFlags ( ) const

inlineinherited

Definition at line 145 of file eda_item.h.

 {
 constexpr int mask =
 ( IS_NEW | IS_PASTED | IS_MOVING | IS_BROKEN | IS_CHANGED | STRUCT_DELETED );
 
 return m_flags & mask;
 }

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

{
 static std::shared_ptr<SHAPE_SEGMENT> slot;
 
 UNIMPLEMENTED_FOR( GetClass() );
 
 return slot;
}

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_TEXT::GetEffectiveShape	(	PCB_LAYER_ID	aLayer = `UNDEFINED_LAYER`,
		FLASHING	aFlash = `FLASHING::DEFAULT`
	)		const

overridevirtual

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

Definition at line 266 of file pcb_text.cpp.

{
 if( IsKnockout() )
 {
 SHAPE_POLY_SET knockouts;
 
 TransformTextToPolySet( knockouts, aLayer, 0, GetBoard()->GetDesignSettings().m_MaxError,
 ERROR_INSIDE );
 
 SHAPE_POLY_SET finalPoly;
 int strokeWidth = GetEffectiveTextPenWidth();
 VECTOR2I fontSize = GetTextSize();
 int margin = strokeWidth * 1.5 + GetKnockoutTextMargin( fontSize, strokeWidth );
 
 TransformBoundingBoxToPolygon( &finalPoly, margin );
 finalPoly.BooleanSubtract( knockouts, SHAPE_POLY_SET::PM_FAST );
 finalPoly.Fracture( SHAPE_POLY_SET::PM_FAST );
 
 return std::make_shared<SHAPE_POLY_SET>( finalPoly );
 }
 
 return GetEffectiveTextShape();
}

References SHAPE_POLY_SET::BooleanSubtract(), ERROR_INSIDE, SHAPE_POLY_SET::Fracture(), BOARD_ITEM::GetBoard(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetEffectiveTextShape(), GetKnockoutTextMargin(), EDA_TEXT::GetTextSize(), BOARD_ITEM::IsKnockout(), SHAPE_POLY_SET::PM_FAST, EDA_TEXT::TransformBoundingBoxToPolygon(), and TransformTextToPolySet().

◆ GetEffectiveTextPenWidth()

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

inherited

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

Definition at line 297 of file eda_text.cpp.

{
 int penWidth = GetTextThickness();
 
 if( penWidth <= 1 )
 {
 penWidth = aDefaultPenWidth;
 
 if( IsBold() )
 penWidth = GetPenSizeForBold( GetTextWidth() );
 else if( penWidth <= 1 )
 penWidth = GetPenSizeForNormal( GetTextWidth() );
 }
 
 // Clip pen size for small texts:
 penWidth = Clamp_Text_PenSize( penWidth, GetTextSize() );
 
 return penWidth;
}

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

Referenced by BOARD_ADAPTER::addText(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), SCH_LABEL_BASE::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), FP_TEXT::GetEffectiveShape(), GetEffectiveShape(), EDA_TEXT::GetEffectiveTextShape(), LIB_FIELD::GetPenWidth(), LIB_TEXT::GetPenWidth(), 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(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), EDA_TEXT::printOneLineOfText(), FP_TEXT::TransformTextToPolySet(), FP_TEXTBOX::TransformTextToPolySet(), TransformTextToPolySet(), PCB_TEXTBOX::TransformTextToPolySet(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::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`,
		bool	aUseTextRotation = `true`
	)		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 853 of file eda_text.cpp.

{
 std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
 KIGFX::GAL_DISPLAY_OPTIONS empty_opts;
 KIFONT::FONT* font = getDrawFont();
 int penWidth = GetEffectiveTextPenWidth();
 TEXT_ATTRIBUTES attrs = GetAttributes();
 
 if( aUseTextRotation )
 attrs.m_Angle = GetDrawRotation();
 else
 attrs.m_Angle = ANGLE_0;
 
 if( aTriangulate )
 {
 CALLBACK_GAL callback_gal(
 empty_opts,
 // Stroke callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
 {
 shape->AddShape( new SHAPE_SEGMENT( aPt1, aPt2, penWidth ) );
 },
 // Triangulation callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2, const VECTOR2I& aPt3 )
 {
 SHAPE_SIMPLE* triShape = new SHAPE_SIMPLE;
 
 for( const VECTOR2I& point : { aPt1, aPt2, aPt3 } )
 triShape->Append( point.x, point.y );
 
 shape->AddShape( triShape );
 } );
 
 font->Draw( &callback_gal, GetShownText(), GetDrawPos(), attrs );
 }
 else
 {
 CALLBACK_GAL callback_gal(
 empty_opts,
 // Stroke callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
 {
 shape->AddShape( new SHAPE_SEGMENT( aPt1, aPt2, penWidth ) );
 },
 // Outline callback
 [&]( const SHAPE_LINE_CHAIN& aPoly )
 {
 shape->AddShape( aPoly.Clone() );
 } );
 
 font->Draw( &callback_gal, GetShownText(), GetDrawPos(), attrs );
 }
 
 return shape;
}

References ANGLE_0, SHAPE_SIMPLE::Append(), KIFONT::FONT::Draw(), EDA_TEXT::GetAttributes(), EDA_TEXT::getDrawFont(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetShownText(), and TEXT_ATTRIBUTES::m_Angle.

Referenced by FP_TEXT::GetEffectiveShape(), FP_TEXTBOX::GetEffectiveShape(), GetEffectiveShape(), PCB_TEXTBOX::GetEffectiveShape(), PCB_SELECTION_TOOL::hitTestDistance(), PNS_KICAD_IFACE_BASE::syncTextItem(), and EDA_TEXT::TransformBoundingBoxToPolygon().

◆ GetFlags()

EDA_ITEM_FLAGS EDA_ITEM::GetFlags ( ) const

inlineinherited

Definition at line 142 of file eda_item.h.

142{ return m_flags; }

References EDA_ITEM::m_flags.

Referenced by BACK_ANNOTATE::applyChangelist(), BuildBoardPolygonOutlines(), collidesWithArea(), ConvertOutlineToPolygon(), SCH_EDIT_FRAME::ConvertPart(), BOARD_COMMIT::dirtyIntersectingZones(), PL_EDIT_TOOL::DoDelete(), PCB_TOOL_BASE::doInteractiveItemPlacement(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRC_ENGINE::EvalRules(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), LIB_SYMBOL::LIB_SYMBOL(), 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_TOOL::RecombinePad(), BOARD::Remove(), FOOTPRINT::Remove(), SCH_EDIT_FRAME::SaveCopyInUndoList(), SCH_EDIT_FRAME::SelectUnit(), DS_DATA_ITEM::SyncDrawItems(), DS_DATA_ITEM_POLYGONS::SyncDrawItems(), DS_DATA_ITEM_BITMAP::SyncDrawItems(), CONNECTIVITY_DATA::TestTrackEndpointDangling(), and DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow().

◆ 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, and PCB_TRACK.

Definition at line 256 of file eda_item.h.

256{ return GetPosition(); }

EDA_ITEM::GetPosition

virtual VECTOR2I GetPosition() const

Definition: eda_item.h:249

References EDA_ITEM::GetPosition().

Referenced by SCH_EDIT_FRAME::FocusOnItem().

◆ GetFont()

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

inlineinherited

Definition at line 188 of file eda_text.h.

188{ return m_attributes.m_Font; }

TEXT_ATTRIBUTES::m_Font

KIFONT::FONT * m_Font

Definition: text_attributes.h:66

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

◆ GetFontName()

wxString EDA_TEXT::GetFontName ( ) const

inherited

Definition at line 757 of file eda_text.cpp.

{
 if( GetFont() )
 return GetFont()->GetName();
 else
 return wxEmptyString;
}

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

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

◆ GetFriendlyName()

wxString EDA_ITEM::GetFriendlyName ( ) const

virtualinherited

Reimplemented in PCB_SHAPE, PCB_TRACK, and ZONE.

Definition at line 310 of file eda_item.cpp.

{
 return GetTypeDesc();
}

References EDA_ITEM::GetTypeDesc().

Referenced by PROPERTIES_PANEL::rebuildProperties().

◆ GetHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::GetHorizJustify ( ) const

inlineinherited

Definition at line 149 of file eda_text.h.

149{ return m_attributes.m_Halign; };

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), AUTOPLACER::fieldHPlacement(), EDA_TEXT::Format(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), FP_TEXTBOX::GetDrawPos(), PCB_TEXTBOX::GetDrawPos(), SCH_FIELD::GetEffectiveHorizJustify(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::IsHorizJustifyFlipped(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EDIT_TOOL::Mirror(), FP_TEXT::Mirror(), Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXTBOX::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), LIB_TEXTBOX::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), LIB_TEXT::NormalizeJustification(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetHyperlink()

wxString EDA_TEXT::GetHyperlink ( ) const

inlineinherited

Definition at line 334 of file eda_text.h.

334{ return m_hyperlink; }

EDA_TEXT::m_hyperlink

wxString m_hyperlink

A hyperlink URL.

Definition: eda_text.h:386

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(), 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 497 of file eda_text.cpp.

{
 return KiROUND( getDrawFont()->GetInterline( GetTextHeight() ) );
}

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

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

◆ GetItemDescription()

wxString PCB_TEXT::GetItemDescription ( UNITS_PROVIDER * aUnitsProvider ) const

overridevirtual

Return a user-visible description string of this item.

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

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

Returns: The menu text string.

Reimplemented from EDA_ITEM.

Definition at line 238 of file pcb_text.cpp.

{
 return wxString::Format( _( "PCB Text '%s' on %s"),
 KIUI::EllipsizeMenuText( GetShownText() ),
 GetLayerName() );
}

References _, KIUI::EllipsizeMenuText(), Format(), BOARD_ITEM::GetLayerName(), and GetShownText().

◆ getKnockoutMargin()

int PCB_TEXT::getKnockoutMargin ( ) const

protected

Definition at line 132 of file pcb_text.cpp.

{
 VECTOR2I textSize( GetTextWidth(), GetTextHeight() );
 int thickness = GetTextThickness();
 
 return thickness * 1.5 + GetKnockoutTextMargin( textSize, thickness );
}

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

Referenced by GetBoundingBox(), and TextHitTest().

◆ GetLayer()

virtual PCB_LAYER_ID BOARD_ITEM::GetLayer ( ) const

inlinevirtualinherited

Return the primary layer this item is on.

Reimplemented in FOOTPRINT, PAD, and ZONE.

Definition at line 180 of file board_item.h.

180{ return m_layer; }

BOARD_ITEM::m_layer

PCB_LAYER_ID m_layer

Definition: board_item.h:329

References BOARD_ITEM::m_layer.

◆ GetLayerName()

wxString BOARD_ITEM::GetLayerName ( ) const

inherited

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

Returns: the layer name associated with this item.

Definition at line 94 of file board_item.cpp.

{
 const BOARD* board = GetBoard();
 
 if( board )
 return board->GetLayerName( m_layer );
 
 // If no parent, return standard name
 return BOARD::GetStandardLayerName( m_layer );
}

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

Referenced by FP_SHAPE::GetItemDescription(), PCB_DIMENSION_BASE::GetItemDescription(), PCB_SHAPE::GetItemDescription(), GetItemDescription(), PCB_TEXTBOX::GetItemDescription(), PCB_TRACK::GetItemDescription(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), GetShownText(), PCB_TEXTBOX::GetShownText(), and FOOTPRINT::ResolveTextVar().

◆ GetLayerSet()

virtual LSET BOARD_ITEM::GetLayerSet ( ) const

inlinevirtualinherited

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

Reimplemented in PCB_GROUP, PAD, PCB_VIA, and ZONE.

Definition at line 185 of file board_item.h.

 {
 if( m_layer == UNDEFINED_LAYER )
 return LSET();
 else
 return LSET( m_layer );
 }

References BOARD_ITEM::m_layer, and UNDEFINED_LAYER.

Referenced by PCB_GRID_HELPER::BestSnapAnchor(), KI_TEST::CheckFpShape(), collidesWithArea(), BOARD_COMMIT::dirtyIntersectingZones(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), DRAWING_TOOL::DrawVia(), DRC_ENGINE::EvalRules(), existsOnLayerFunc(), extractDiffPairCoupledItems(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), Flip(), PCB_TEXTBOX::Flip(), hash_board_item(), BOARD_INSPECTION_TOOL::InspectClearance(), PNS_KICAD_IFACE::IsItemVisible(), isMaskAperture(), BOARD_ITEM::layerMaskDescribe(), FABMASTER::loadZone(), PCB_DIMENSION_BASE::Mirror(), PCB_GRID_HELPER::nearestAnchor(), 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(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), PCB_SELECTION_CONDITIONS::sameLayerFunc(), PCB_SELECTION_TOOL::selectAllConnectedTracks(), 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().

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

{
 VECTOR2I pos = GetDrawPos(); // Position of first line of the multiline text according
 // to the center of the multiline text block
 
 VECTOR2I offset; // Offset to next line.
 
 offset.y = GetInterline();
 
 if( aLineCount > 1 )
 {
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 break;
 
 case GR_TEXT_V_ALIGN_CENTER:
 pos.y -= ( aLineCount - 1 ) * offset.y / 2;
 break;
 
 case GR_TEXT_V_ALIGN_BOTTOM:
 pos.y -= ( aLineCount - 1 ) * offset.y;
 break;
 }
 }
 
 // Rotate the position of the first line around the center of the multiline text block
 RotatePoint( pos, GetDrawPos(), GetDrawRotation() );
 
 // Rotate the offset lines to increase happened in the right direction
 RotatePoint( offset, GetDrawRotation() );
 
 for( int ii = 0; ii < aLineCount; ii++ )
 {
 aPositions.push_back( (VECTOR2I) pos );
 pos += offset;
 }
}

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_TOP, RotatePoint(), and VECTOR2< T >::y.

Referenced by SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotPcbText(), and EDA_TEXT::Print().

◆ GetLineSpacing()

double EDA_TEXT::GetLineSpacing ( ) const

inlineinherited

Definition at line 193 of file eda_text.h.

193{ return m_attributes.m_LineSpacing; }

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

Referenced by EDA_TEXT::Format().

◆ GetMenuImage()

BITMAPS PCB_TEXT::GetMenuImage ( ) const

overridevirtual

Reimplemented from EDA_ITEM.

Definition at line 246 of file pcb_text.cpp.

{
 return BITMAPS::text;
}

References text.

◆ GetMsgPanelInfo()

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

overridevirtual

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

Parameters

aList is the list to populate.

Reimplemented from EDA_ITEM.

Definition at line 111 of file pcb_text.cpp.

{
 // Don't use GetShownText() here; we want to show the user the variable references
 aList.emplace_back( _( "PCB Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
 
 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME && IsLocked() )
  aList.emplace_back( _( "Status" ), _( "Locked" ) );
 
 aList.emplace_back( _( "Layer" ), GetLayerName() );
 
 aList.emplace_back( _( "Mirror" ), IsMirrored() ? _( "Yes" ) : _( "No" ) );
 
 aList.emplace_back( _( "Angle" ), wxString::Format( wxT( "%g" ), GetTextAngle().AsDegrees() ) );
 
 aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
 aList.emplace_back( _( "Thickness" ), aFrame->MessageTextFromValue( GetTextThickness() ) );
 aList.emplace_back( _( "Width" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
 aList.emplace_back( _( "Height" ), aFrame->MessageTextFromValue( GetTextHeight() ) );
}

References _, KIUI::EllipsizeStatusText(), Format(), EDA_TEXT::GetFont(), BOARD_ITEM::GetLayerName(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextThickness(), EDA_TEXT::GetTextWidth(), BOARD_ITEM::IsLocked(), EDA_TEXT::IsMirrored(), UNITS_PROVIDER::MessageTextFromValue(), and PCB_EDIT_FRAME_NAME.

◆ GetParent()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 163 of file board_item.h.

163{ return (BOARD_ITEM_CONTAINER*) m_parent; }

EDA_ITEM::m_parent

EDA_ITEM * m_parent

Linked list: Link (parent struct)

Definition: eda_item.h:496

References EDA_ITEM::m_parent.

◆ GetParentFootprint()

BOARD_ITEM_CONTAINER * BOARD_ITEM::GetParentFootprint ( ) const

inherited

Definition at line 239 of file board_item.cpp.

{
 BOARD_ITEM_CONTAINER* ancestor = GetParent();
 
 while( ancestor && ancestor->Type() == PCB_GROUP_T )
 ancestor = ancestor->GetParent();
 
 return ( ancestor && ancestor->Type() == PCB_FOOTPRINT_T ) ? ancestor : nullptr;
}

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), DRC_TEST_PROVIDER_SOLDER_MASK::checkItemMask(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), PNS::ITEM::collideSimple(), CONVERT_TOOL::CreatePolys(), KIGFX::PCB_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), PCB_SHAPE::GetParentFootprint(), PNS_PCBNEW_RULE_RESOLVER::IsInNetTie(), DRC_ENGINE::IsNetTieExclusion(), LEGACY_PLUGIN::loadMODULE_TEXT(), PAD_TOOL::RecombinePad(), PAD::SameLogicalPadAs(), PAD::SharesNetTieGroup(), DRC_TEST_PROVIDER_SOLDER_MASK::testItemAgainstItems(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::testShapeLineChain(), and zonesNeedUpdate().

◆ GetParentGroup()

PCB_GROUP * BOARD_ITEM::GetParentGroup ( ) const

inlineinherited

Definition at line 72 of file board_item.h.

72{ return m_group; }

BOARD_ITEM::m_group

PCB_GROUP * m_group

Definition: board_item.h:334

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), BOARD_ITEM::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), getClosestGroup(), BOARD::GroupLegalOps(), BOARD_ITEM::IsLocked(), memberOfFunc(), BOARD::Move(), PCB_CONTROL::Paste(), PCB_CONTROL::placeBoardItems(), BOARD_COMMIT::Push(), BOARD::Remove(), FOOTPRINT::Remove(), GROUP_TOOL::RemoveFromGroup(), BOARD_ITEM::SwapItemData(), DIALOG_GROUP_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::visitItem(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::visitItem(), and PCB_GROUP::WithinScope().

◆ GetPosition()

virtual VECTOR2I PCB_TEXT::GetPosition ( ) const

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 76 of file pcb_text.h.

 {
 return EDA_TEXT::GetTextPos();
 }

References EDA_TEXT::GetTextPos().

Referenced by PCB_GRID_HELPER::computeAnchors(), ALTIUM_PCB::HelperParseDimensions6Radial(), PCB_POINT_EDITOR::makePoints(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_POINT_EDITOR::updateItem(), and PCB_POINT_EDITOR::updatePoints().

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

{
 if( getDrawFont()->IsOutline() )
 {
 EDA_ANGLE resolvedAngle = GetDrawRotation();
 
 if( m_render_cache.empty()
 || m_render_cache_text != forResolvedText
 || m_render_cache_angle != resolvedAngle
 || m_render_cache_offset != aOffset )
 {
 m_render_cache.clear();
 
 KIFONT::OUTLINE_FONT* font = static_cast<KIFONT::OUTLINE_FONT*>( getDrawFont() );
 TEXT_ATTRIBUTES attrs = GetAttributes();
 
 attrs.m_Angle = resolvedAngle;
 
 font->GetLinesAsGlyphs( &m_render_cache, GetShownText(), GetDrawPos() + aOffset, attrs );
 m_render_cache_angle = resolvedAngle;
 m_render_cache_text = forResolvedText;
 m_render_cache_offset = aOffset;
 }
 
 return &m_render_cache;
 }
 
 return nullptr;
}

References EDA_TEXT::GetAttributes(), EDA_TEXT::getDrawFont(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetDrawRotation(), KIFONT::OUTLINE_FONT::GetLinesAsGlyphs(), EDA_TEXT::GetShownText(), TEXT_ATTRIBUTES::m_Angle, EDA_TEXT::m_render_cache, EDA_TEXT::m_render_cache_angle, EDA_TEXT::m_render_cache_offset, and EDA_TEXT::m_render_cache_text.

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

◆ GetShownText()

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

overridevirtual

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

Parameters

aDepth	is used to prevent infinite recursions and loops when expanding text variables.
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).

Reimplemented from EDA_TEXT.

Definition at line 56 of file pcb_text.cpp.

{
 BOARD* board = dynamic_cast<BOARD*>( GetParent() );
 
 std::function<bool( wxString* )> pcbTextResolver =
 [&]( wxString* token ) -> bool
 {
 if( token->IsSameAs( wxT( "LAYER" ) ) )
 {
 *token = GetLayerName();
 return true;
 }
 
 if( board->ResolveTextVar( token, aDepth + 1 ) )
 {
 return true;
 }
 
 return false;
 };
 
 wxString text = EDA_TEXT::GetShownText();
 
 if( board && HasTextVars() && aDepth < 10 )
 text = ExpandTextVars( text, &pcbTextResolver );
 
 return text;
}

References ExpandTextVars(), BOARD_ITEM::GetLayerName(), BOARD_ITEM::GetParent(), EDA_TEXT::GetShownText(), EDA_TEXT::HasTextVars(), BOARD::ResolveTextVar(), and text.

Referenced by KIGFX::PCB_PAINTER::draw(), GetItemDescription(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), Matches(), 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 265 of file eda_item.h.

265{ return GetPosition(); }

References EDA_ITEM::GetPosition().

◆ GetState()

int EDA_ITEM::GetState ( EDA_ITEM_FLAGS type ) const

inlineinherited

Definition at line 123 of file eda_item.h.

 {
 return m_status & type;
 }

References EDA_ITEM::m_status.

◆ GetStatus()

EDA_ITEM_FLAGS EDA_ITEM::GetStatus ( ) const

inlineinherited

Definition at line 136 of file eda_item.h.

136{ return m_status; }

References EDA_ITEM::m_status.

◆ GetStroke()

STROKE_PARAMS BOARD_ITEM::GetStroke ( ) const

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 82 of file board_item.cpp.

{
 wxCHECK( false, STROKE_PARAMS( pcbIUScale.mmToIU( DEFAULT_LINE_WIDTH ) ) );
}

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

Referenced by CONVERT_TOOL::CreatePolys(), and PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog().

◆ 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 87 of file eda_text.h.

87{ return m_text; }

References EDA_TEXT::m_text.

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_SHEET_PATH::AddNewSymbolInstances(), NETLIST_EXPORTER_XML::addSymbolFields(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_FRAME::AutoRotateItem(), EE_SELECTION_TOOL::autostartEvent(), CONNECTION_GRAPH::buildConnectionGraph(), SCH_EDIT_TOOL::ChangeTextType(), CheckLibSymbol(), SCH_SHEET::CleanupSheet(), LIB_TEXT::Clone(), LIB_FIELD::compare(), LIB_TEXT::compare(), LIB_TEXTBOX::compare(), SCH_BUS_WIRE_ENTRY::ConnectionPropagatesTo(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), DIALOG_LIB_FIELD_PROPERTIES::DIALOG_LIB_FIELD_PROPERTIES(), DIALOG_SCH_FIELD_PROPERTIES::DIALOG_SCH_FIELD_PROPERTIES(), KIGFX::SCH_VIEW::DisplaySymbol(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CONNECTION_GRAPH::ercCheckHierSheets(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), LIB_SYMBOL::Flatten(), PCB_PLUGIN::format(), LIB_SYMBOL::GetFootprint(), SCH_SYMBOL::GetFootprintFieldText(), LIB_FIELD::GetFullText(), FOOTPRINT_INFO_GENERATOR::GetHtmlFieldRow(), SCH_LABEL_BASE::GetIntersheetRefs(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadNet(), FP_TEXT::GetLength(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), LIB_SYMBOL::GetPrefix(), SCH_SYMBOL::GetRef(), FOOTPRINT::GetReference(), LIB_SYMBOL::GetSearchText(), PCB_DIMENSION_BASE::GetText(), FOOTPRINT::GetValue(), SCH_SYMBOL::GetValueFieldText(), hash_fp_item(), SCH_SHEET::HasUndefinedPins(), LIB_FIELD::HitTest(), SCH_DRAWING_TOOLS::importHierLabel(), SCH_LABEL_BASE::IncrementLabel(), GENERAL_COLLECTOR::Inspect(), CADSTAR_SCH_ARCHIVE_LOADER::Load(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_EAGLE_PLUGIN::loadSchematic(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_EAGLE_PLUGIN::loadSegments(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), LIB_TEXTBOX::Matches(), SCH_LABEL_BASE::Matches(), SCH_SHEET_PIN::Matches(), SCH_TEXT::Matches(), SCH_TEXTBOX::Matches(), DIALOG_SHEET_PIN_PROPERTIES::onComboBox(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), SCH_FIELD::operator<(), SCH_TEXT::operator<(), SCH_TEXTBOX::operator<(), LIB_FIELD::operator=(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_EDITOR_CONTROL::Paste(), DRAWING_TOOL::PlaceText(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItems(), DIALOG_RESCUE_EACH::PopulateInstanceList(), LIB_FIELD::print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_EDIT_FRAME::PutDataInPreviousState(), NETLIST_EXPORTER_SPICE_MODEL::readPorts(), SCHEMATIC::RecomputeIntersheetRefs(), SCH_GLOBALLABEL::ResolveTextVar(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveField(), CLIPBOARD_IO::SaveSelection(), SCH_LEGACY_PLUGIN::saveSheet(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_LEGACY_PLUGIN::saveSymbol(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), SCH_EDIT_FRAME::SendSelectItemsToPcb(), SYMBOL_EDIT_FRAME::setupUIConditions(), SYMBOL_VIEWER_FRAME::setupUIConditions(), EE_INSPECTION_TOOL::ShowDatasheet(), SCH_SHEET::SymbolCount(), textsNeedUpdate(), DIALOG_EDIT_SYMBOLS_LIBID::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_SYMBOL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), EDA_TEXT::TransformBoundingBoxToPolygon(), SCH_EDITOR_CONTROL::updatePastedSymbol(), SCH_SYMBOL::UpdatePrefix(), SYMBOL_EDIT_FRAME::UpdateSymbolMsgPanelInfo(), and FP_TEXT::ViewGetLOD().

◆ GetTextAngle()

const EDA_ANGLE & EDA_TEXT::GetTextAngle ( ) const

inlineinherited

Definition at line 120 of file eda_text.h.

120{ return m_attributes.m_Angle; }

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(), LIB_TEXTBOX::compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), Flip(), PCB_TEXTBOX::Flip(), PCB_PLUGIN::format(), SCH_LABEL::GetBodyBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), GetBoundingBox(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), EDA_TEXT::GetDrawRotation(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), FP_TEXTBOX::GetDrawRotation(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), hash_fp_item(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), FP_TEXT::KeepUpright(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), FP_TEXT::Mirror(), Mirror(), PCB_DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXTBOX::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), LIB_TEXTBOX::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), LIB_TEXT::NormalizeJustification(), KI_TEST::kitest_cmp_drawings::operator()(), EAGLE_PLUGIN::orientFPText(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), positioningChanged(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), SCH_EDIT_TOOL::Rotate(), SCH_TEXTBOX::Rotate(), LIB_TEXTBOX::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), FP_TEXTBOX::Rotate(), PCB_DIMENSION_BASE::Rotate(), Rotate(), PCB_TEXTBOX::Rotate(), SCH_TEXTBOX::Rotate90(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_SEXPR_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_SEXPR_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SCH_FIELD_PROPERTIES::UpdateField(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), and PCB_DIM_LEADER::updateGeometry().

◆ GetTextAngleDegrees()

double EDA_TEXT::GetTextAngleDegrees ( ) const

inlineinherited

Definition at line 127 of file eda_text.h.

127{ return m_attributes.m_Angle.AsDegrees(); }

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

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ GetTextBox()

BOX2I EDA_TEXT::GetTextBox	(	int	aLine = `-1`,
		bool	aInvertY = `false`
	)		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.
aInvertY	Invert the Y axis when calculating bounding box.

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

{
 VECTOR2I drawPos = GetDrawPos();
 
 if( m_bounding_box_cache_valid
 && m_bounding_box_cache_pos == drawPos
 && m_bounding_box_cache_line == aLine
 && m_bounding_box_cache_inverted == aInvertY )
 {
 return m_bounding_box_cache;
 }
 
 BOX2I bbox;
 wxArrayString strings;
 wxString text = GetShownText();
 int thickness = GetEffectiveTextPenWidth();
 
 if( IsMultilineAllowed() )
 {
 wxStringSplit( text, strings, '\n' );
 
 if( strings.GetCount() ) // GetCount() == 0 for void strings with multilines allowed
 {
  if( aLine >= 0 && ( aLine < static_cast<int>( strings.GetCount() ) ) )
 text = strings.Item( aLine );
 else
 text = strings.Item( 0 );
 }
 }
 
 // calculate the H and V size
 KIFONT::FONT* font = getDrawFont();
 VECTOR2D fontSize( GetTextSize() );
 bool bold = IsBold();
 bool italic = IsItalic();
 VECTOR2I extents = font->StringBoundaryLimits( text, fontSize, thickness, bold, italic );
 int overbarOffset = 0;
 
 // Creates bounding box (rectangle) for horizontal, left and top justified text. The
 // bounding box will be moved later according to the actual text options
 wxSize textsize = wxSize( extents.x, extents.y );
 VECTOR2I pos = drawPos;
 
 if( IsMultilineAllowed() && aLine > 0 && aLine < (int) strings.GetCount() )
 pos.y -= KiROUND( aLine * font->GetInterline( fontSize.y ) );
 
 if( text.Contains( wxT( "~{" ) ) )
 overbarOffset = extents.y / 14;
 
 if( aInvertY )
 pos.y = -pos.y;
 
 bbox.SetOrigin( pos );
 
 // for multiline texts and aLine < 0, merge all rectangles (aLine == -1 signals all lines)
 if( IsMultilineAllowed() && aLine < 0 && strings.GetCount() )
 {
 for( unsigned ii = 1; ii < strings.GetCount(); ii++ )
 {
 text = strings.Item( ii );
 extents = font->StringBoundaryLimits( text, fontSize, thickness, bold, italic );
 textsize.x = std::max( textsize.x, extents.x );
 }
 
 // interline spacing is only *between* lines, so total height is the height of the first
 // line plus the interline distance (with interline spacing) for all subsequent lines
 textsize.y += KiROUND( ( strings.GetCount() - 1 ) * font->GetInterline( fontSize.y ) );
 }
 
 bbox.SetSize( textsize );
 
 /*
 * At this point the rectangle origin is the text origin (m_Pos). This is correct only for
 * left and top justified, non-mirrored, non-overbarred texts. Recalculate for all others.
 */
 int italicOffset = IsItalic() ? KiROUND( fontSize.y * ITALIC_TILT ) : 0;
 
 switch( GetHorizJustify() )
 {
 case GR_TEXT_H_ALIGN_LEFT:
 if( IsMirrored() )
 bbox.SetX( bbox.GetX() - ( bbox.GetWidth() - italicOffset ) );
 break;
 
 case GR_TEXT_H_ALIGN_CENTER:
 bbox.SetX( bbox.GetX() - ( bbox.GetWidth() - italicOffset ) / 2 );
 break;
 
 case GR_TEXT_H_ALIGN_RIGHT:
 if( !IsMirrored() )
 bbox.SetX( bbox.GetX() - ( bbox.GetWidth() - italicOffset ) );
 break;
 }
 
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 break;
 
 case GR_TEXT_V_ALIGN_CENTER:
 bbox.SetY( bbox.GetY() - ( bbox.GetHeight() + overbarOffset ) / 2 );
 break;
 
 case GR_TEXT_V_ALIGN_BOTTOM:
 bbox.SetY( bbox.GetY() - ( bbox.GetHeight() + overbarOffset ) );
 break;
 }
 
 bbox.Normalize(); // Make h and v sizes always >= 0
 
 m_bounding_box_cache_valid = true;
 m_bounding_box_cache_pos = drawPos;
 m_bounding_box_cache_line = aLine;
 m_bounding_box_cache_inverted = aInvertY;
 m_bounding_box_cache = bbox;
 
 return bbox;
}

References EDA_TEXT::getDrawFont(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetEffectiveTextPenWidth(), 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_LEFT, GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_BOTTOM, GR_TEXT_V_ALIGN_CENTER, GR_TEXT_V_ALIGN_TOP, EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_TEXT::IsMirrored(), EDA_TEXT::IsMultilineAllowed(), ITALIC_TILT, KiROUND(), EDA_TEXT::m_bounding_box_cache, EDA_TEXT::m_bounding_box_cache_inverted, 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 >::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::SCH_PAINTER::draw(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), DS_DRAW_ITEM_TEXT::GetBoundingBox(), FP_TEXT::GetBoundingBox(), PCB_DIMENSION_BASE::GetBoundingBox(), GetBoundingBox(), LIB_TEXT::HitTest(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), LIB_TEXT::NormalizeJustification(), SCH_TEXT::Plot(), SCH_TEXT::Print(), EDA_TEXT::TextHitTest(), FP_TEXT::TextHitTest(), EDA_TEXT::TransformBoundingBoxToPolygon(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), and FP_TEXT::ViewBBox().

◆ GetTextColor()

COLOR4D EDA_TEXT::GetTextColor ( ) const

inlineinherited

Definition at line 205 of file eda_text.h.

205{ return m_attributes.m_Color; }

TEXT_ATTRIBUTES::m_Color

KIGFX::COLOR4D m_Color

Definition: text_attributes.h:75

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

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT::Format(), SCH_FIELD::GetFieldColor(), SCH_LABEL_BASE::GetLabelColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), DS_DRAW_ITEM_TEXT::PrintWsItem(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetTextHeight()

int EDA_TEXT::GetTextHeight ( ) const

inlineinherited

Definition at line 202 of file eda_text.h.

202{ return m_attributes.m_Size.y; }

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

Referenced by SCH_LABEL_BASE::AutoplaceFields(), LIB_FIELD::compare(), LIB_TEXT::compare(), LIB_TEXTBOX::compare(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_HIERLABEL::GetBodyBoundingBox(), EDA_TEXT::GetInterline(), getKnockoutMargin(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_GLOBALLABEL::GetSchematicTextOffset(), hash_fp_item(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_SEXPR_PLUGIN::saveField(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ GetTextPos()

const VECTOR2I & EDA_TEXT::GetTextPos ( ) const

inlineinherited

Definition at line 208 of file eda_text.h.

208{ return m_pos; }

References EDA_TEXT::m_pos.

Referenced by SCH_LABEL_BASE::AutoplaceFields(), LIB_FIELD::compare(), LIB_TEXT::compare(), 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(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), Flip(), PCB_PLUGIN::format(), SCH_LABEL_BASE::GetBodyBoundingBox(), SCH_LABEL::GetBodyBoundingBox(), SCH_HIERLABEL::GetBodyBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), FP_TEXT::GetBoundingBox(), GetBoundingBox(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LABEL_BASE::GetConnectionPoints(), EDA_TEXT::GetDrawPos(), SCH_LABEL_BASE::GetEndPoints(), SCH_SHEET_PIN::GetEndPoints(), SCH_FIELD::GetLibPosition(), LIB_FIELD::GetPosition(), LIB_TEXT::GetPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetPosition(), DS_DRAW_ITEM_TEXT::GetPosition(), FP_TEXT::GetPosition(), GetPosition(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), FP_TEXT::Mirror(), Mirror(), PCB_DIMENSION_BASE::Mirror(), LIB_FIELD::MirrorHorizontal(), LIB_TEXT::MirrorHorizontal(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), LIB_FIELD::MirrorVertical(), LIB_TEXT::MirrorVertical(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), LIB_TEXT::NormalizeJustification(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), DRAWING_TOOL::PlaceText(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_FIELD::print(), SCH_LABEL_BASE::Print(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), FP_TEXT::SetDrawCoord(), FP_TEXT::SetLocalCoord(), FP_TEXT::TextHitTest(), FP_TEXT::TransformTextToPolySet(), TransformTextToPolySet(), SCH_LABEL_BASE::UpdateDanglingState(), and FP_TEXT::ViewBBox().

◆ GetTextSize()

VECTOR2I EDA_TEXT::GetTextSize ( ) const

inlineinherited

Definition at line 196 of file eda_text.h.

196{ return m_attributes.m_Size; }

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), FP_TEXT::GetEffectiveShape(), GetEffectiveShape(), EDA_TEXT::GetEffectiveTextPenWidth(), SCH_LABEL_BASE::GetLabelBoxExpansion(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), LIB_TEXTBOX::GetTextMargin(), SCH_TEXTBOX::GetTextMargin(), FP_TEXTBOX::GetTextMargin(), PCB_TEXTBOX::GetTextMargin(), SCH_TEXT::GetTextOffset(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), EAGLE_PLUGIN::orientFPText(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN::saveSheet(), textsNeedUpdate(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetTextStyleName()

wxString EDA_TEXT::GetTextStyleName ( ) const

inherited

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

Definition at line 736 of file eda_text.cpp.

{
 int style = 0;
 
 if( IsItalic() )
 style = 1;
 
 if( IsBold() )
 style += 2;
 
 wxString stylemsg[4] = {
 _("Normal"),
 _("Italic"),
 _("Bold"),
 _("Bold+Italic")
 };
 
 return stylemsg[style];
}

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

Referenced by LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), and SCH_FIELD::GetMsgPanelInfo().

◆ GetTextThickness()

int EDA_TEXT::GetTextThickness ( ) const

inlineinherited

Definition at line 112 of file eda_text.h.

112{ return m_attributes.m_StrokeWidth; };

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

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), getKnockoutMargin(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), EDA_TEXT::IsDefaultFormatting(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_LEGACY_PLUGIN::saveText(), textsNeedUpdate(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetTextWidth()

int EDA_TEXT::GetTextWidth ( ) const

inlineinherited

Definition at line 199 of file eda_text.h.

199{ return m_attributes.m_Size.x; }

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

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

{
 //@see EDA_ITEM_DESC for definition of ENUM_MAP<KICAD_T>
 wxString typeDescr = ENUM_MAP<KICAD_T>::Instance().ToString( Type() );
 
 return wxGetTranslation( typeDescr );
}

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

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

◆ GetVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::GetVertJustify ( ) const

inlineinherited

Definition at line 152 of file eda_text.h.

152{ return m_attributes.m_Valign; };

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

Referenced by DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), LIB_TEXTBOX::GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), SCH_FIELD::GetEffectiveVertJustify(), EDA_TEXT::GetLinePositions(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), EDA_TEXT::GetTextBox(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_FIELD::IsVertJustifyFlipped(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), LIB_TEXT::NormalizeJustification(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_TEXT::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), positioningChanged(), LIB_FIELD::print(), EDA_TEXT::printOneLineOfText(), LIB_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetX()

int BOARD_ITEM::GetX ( ) const

inlineinherited

Definition at line 76 of file board_item.h.

 {
 VECTOR2I p = GetPosition();
 return p.x;
 }

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

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsHorizontally(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), BOARD_ITEM::SetY(), TRACK_VIA_DESC::TRACK_VIA_DESC(), and ZONE_DESC::ZONE_DESC().

◆ GetY()

int BOARD_ITEM::GetY ( ) const

inlineinherited

Definition at line 82 of file board_item.h.

 {
 VECTOR2I p = GetPosition();
 return p.y;
 }

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

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), ALIGN_DISTRIBUTE_TOOL::doDistributeGapsVertically(), FOOTPRINT_SEARCH_HANDLER::GetResultCell(), ZONE_SEARCH_HANDLER::GetResultCell(), BOARD_ITEM::SetX(), TRACK_VIA_DESC::TRACK_VIA_DESC(), 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 1004 of file eda_text.cpp.

{
 return wxT( "#" ) + aDestination;
}

Referenced by SCH_SHEET::Plot().

◆ HasFlag()

bool EDA_ITEM::HasFlag ( EDA_ITEM_FLAGS aFlag ) const

inlineinherited

Definition at line 143 of file eda_item.h.

143{ return ( m_flags & aFlag ) == aFlag; }

References EDA_ITEM::m_flags.

Referenced by GRAPHICS_CLEANER::cleanupShapes(), SCH_EDIT_TOOL::DoDelete(), KIGFX::SCH_PAINTER::draw(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_MOVE_TOOL::getConnectedItems(), FOOTPRINT::IsConflicting(), ZONE::IsConflicting(), SCH_MOVE_TOOL::Main(), SCH_SCREEN::MarkConnections(), SCH_MOVE_TOOL::moveItem(), SCH_MOVE_TOOL::orthoLineDrag(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and EE_SELECTION_TOOL::selectMultiple().

◆ HasHole()

virtual bool BOARD_ITEM::HasHole ( ) const

inlinevirtualinherited

Reimplemented in PAD, and PCB_VIA.

Definition at line 128 of file board_item.h.

 {
 return false;
 }

Referenced by DRAWING_TOOL::DrawVia(), hasDrilledHole(), 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::testTrackAgainstItem(), and PCB_CONTROL::UpdateMessagePanel().

◆ HasHyperlink()

virtual bool EDA_TEXT::HasHyperlink ( ) const

inlinevirtualinherited

Definition at line 333 of file eda_text.h.

333{ return !m_hyperlink.IsEmpty(); }

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

172{ return false; }

◆ HasTextVars()

bool EDA_TEXT::HasTextVars ( ) const

inlineinherited

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

Definition at line 103 of file eda_text.h.

103{ return m_shown_text_has_text_var_refs; }

References EDA_TEXT::m_shown_text_has_text_var_refs.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_FIELD::GetShownText(), SCH_LABEL_BASE::GetShownText(), SCH_TEXT::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXT::GetShownText(), FP_TEXTBOX::GetShownText(), GetShownText(), and PCB_TEXTBOX::GetShownText().

◆ HitTest() [1/2]

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

inlineoverridevirtual

Test if aRect intersects this item.

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 107 of file pcb_text.h.

 {
 return TextHitTest( aRect, aContained, aAccuracy );
 }

References TextHitTest().

◆ HitTest() [2/2]

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

inlineoverridevirtual

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

Parameters

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

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

Reimplemented from EDA_ITEM.

Definition at line 102 of file pcb_text.h.

 {
 return TextHitTest( aPosition, aAccuracy );
 }

References TextHitTest().

◆ IsBold()

bool EDA_TEXT::IsBold ( ) const

inlineinherited

Definition at line 133 of file eda_text.h.

133{ return m_attributes.m_Bold; }

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

Referenced by BOARD_ADAPTER::addText(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::getDrawFont(), LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), EDA_TEXT::GetEffectiveTextPenWidth(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetRenderCache(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextStyleName(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), textsNeedUpdate(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ IsBrightened()

bool EDA_ITEM::IsBrightened ( ) const

inlineinherited

Definition at line 108 of file eda_item.h.

108{ return m_flags & BRIGHTENED; }

References BRIGHTENED, and EDA_ITEM::m_flags.

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

◆ 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, and ZONE.

Definition at line 115 of file board_item.h.

 {
 return false;
 }

Referenced by PNS_PCBNEW_RULE_RESOLVER::DpNetPair(), DRC_ENGINE::EvalRules(), PNS::NODE::FindItemByParent(), BOARD_INSPECTION_TOOL::getItemDescription(), 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 766 of file eda_text.cpp.

{
 return ( IsVisible()
 && !IsMirrored()
 && GetHorizJustify() == GR_TEXT_H_ALIGN_CENTER
 && GetVertJustify() == GR_TEXT_V_ALIGN_CENTER
 && GetTextThickness() == 0
 && !IsItalic()
 && !IsBold()
 && !IsMultilineAllowed()
 && GetFontName().IsEmpty()
 );
}

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_SEXPR_PLUGIN::saveField().

◆ IsEntered()

bool EDA_ITEM::IsEntered ( ) const

inlineinherited

Definition at line 107 of file eda_item.h.

107{ return m_flags & ENTERED; }

ENTERED

#define ENTERED

indicates a group has been entered

Definition: eda_item_flags.h:72

References ENTERED, and EDA_ITEM::m_flags.

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

◆ IsForceVisible()

bool EDA_ITEM::IsForceVisible ( ) const

inlineinherited

Definition at line 201 of file eda_item.h.

201{ return m_forceVisible; }

EDA_ITEM::m_forceVisible

bool m_forceVisible

Definition: eda_item.h:497

References EDA_ITEM::m_forceVisible.

Referenced by KIGFX::SCH_PAINTER::draw(), 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 998 of file eda_text.cpp.

{
 return aHref.StartsWith( wxT( "#" ), aDestination );
}

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

◆ IsItalic()

bool EDA_TEXT::IsItalic ( ) const

inlineinherited

Definition at line 130 of file eda_text.h.

130{ return m_attributes.m_Italic; }

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

Referenced by BOARD_ADAPTER::addText(), SCH_DIRECTIVE_LABEL::AutoplaceFields(), SCH_EDIT_TOOL::ChangeTextType(), LIB_TEXTBOX::compare(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::getDrawFont(), LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), LIB_TEXTBOX::getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), LIB_TEXTBOX::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetRenderCache(), LIB_TEXTBOX::GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), EDA_TEXT::GetTextStyleName(), hash_fp_item(), EDA_TEXT::IsDefaultFormatting(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN::saveText(), textsNeedUpdate(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ IsKeepUpright()

bool EDA_TEXT::IsKeepUpright ( ) const

inlineinherited

Definition at line 155 of file eda_text.h.

155{ return m_attributes.m_KeepUpright; }

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

Referenced by PCB_PLUGIN::format(), FP_TEXT::GetDrawRotation(), FP_TEXT::KeepUpright(), and textsNeedUpdate().

◆ IsKnockout()

virtual bool BOARD_ITEM::IsKnockout ( ) const

inlinevirtualinherited

Definition at line 250 of file board_item.h.

250{ return m_isKnockout; }

BOARD_ITEM::m_isKnockout

bool m_isKnockout

Definition: board_item.h:330

References BOARD_ITEM::m_isKnockout.

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), PCB_PLUGIN::format(), GetBoundingBox(), FP_TEXT::GetEffectiveShape(), GetEffectiveShape(), PCB_TEXT_DESC::PCB_TEXT_DESC(), BRDITEMS_PLOTTER::PlotFootprintGraphicItems(), BRDITEMS_PLOTTER::PlotPcbGraphicItem(), PNS_KICAD_IFACE_BASE::syncTextItem(), and TextHitTest().

◆ IsLocked()

bool BOARD_ITEM::IsLocked ( ) const

virtualinherited

Reimplemented in FOOTPRINT, and PAD.

Definition at line 71 of file board_item.cpp.

{
 if( GetParentGroup() )
 return GetParentGroup()->IsLocked();
 
 const BOARD* board = GetBoard();
 
 return board && board->GetBoardUse() != BOARD_USE::FPHOLDER && m_isLocked;
}

References FPHOLDER, 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(), PCB_CONTROL::DeleteItemCursor(), 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_PLUGIN::format(), DSN::SPECCTRA_DB::FromSESSION(), PCB_GROUP::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_SHAPE::GetMsgPanelInfo(), GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfoBase_Common(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GROUP_TOOL::Group(), PCB_SELECTION_CONDITIONS::HasLockedItems(), PCB_SELECTION_CONDITIONS::HasUnlockedItems(), ROUTER_TOOL::InlineDrag(), GENERAL_COLLECTOR::Inspect(), BOARD_ITEM::IsLocked(), PAD::IsLocked(), PCB_SELECTION_TOOL::itemPassesFilter(), CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes(), TRACKS_CLEANER::mergeCollinearSegments(), BOARD_EDITOR_CONTROL::modifyLockSelected(), PCB_POINT_EDITOR::OnSelectionChange(), ZONE_SETTINGS::operator<<(), PCB_SELECTION_TOOL::RequestSelection(), PNS_KICAD_IFACE_BASE::syncArc(), PNS_KICAD_IFACE_BASE::syncTrack(), PNS_KICAD_IFACE_BASE::syncVia(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow(), BOARD_ITEM::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 102 of file eda_item.h.

102{ return m_flags & IS_CHANGED; }

References IS_CHANGED, and EDA_ITEM::m_flags.

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ IsMoving()

bool EDA_ITEM::IsMoving ( ) const

inlineinherited

Definition at line 104 of file eda_item.h.

104{ return m_flags & IS_MOVING; }

References IS_MOVING, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::AutoplaceFields(), LIB_PIN::CalcEdit(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Mirror(), PCB_BASE_FRAME::PlaceFootprint(), SCH_EDIT_TOOL::Rotate(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Swap().

◆ IsMultilineAllowed()

bool EDA_TEXT::IsMultilineAllowed ( ) const

inlineinherited

Definition at line 146 of file eda_text.h.

146{ return m_attributes.m_Multiline; }

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

Referenced by EDA_TEXT::GetTextBox(), EDA_TEXT::IsDefaultFormatting(), BRDITEMS_PLOTTER::PlotPcbText(), and EDA_TEXT::Print().

◆ IsNew()

bool EDA_ITEM::IsNew ( ) const

inlineinherited

Definition at line 103 of file eda_item.h.

103{ return m_flags & IS_NEW; }

References IS_NEW, and EDA_ITEM::m_flags.

Referenced by SCH_EDIT_FRAME::AddItemToScreenAndUndoList(), SCH_EDIT_TOOL::ChangeTextType(), SCH_EDIT_TOOL::ConvertDeMorgan(), EDIT_TOOL::DragArcTrack(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_MOVE_TOOL::getConnectedDragItems(), DIALOG_PIN_PROPERTIES::getSyncPinsMessage(), SYMBOL_EDITOR_DRAWING_TOOLS::Init(), SCH_LINE_WIRE_BUS_TOOL::IsDrawingLineWireOrBus(), EE_POINT_EDITOR::Main(), SCH_MOVE_TOOL::Main(), SYMBOL_EDITOR_MOVE_TOOL::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 DIALOG_SHEET_PROPERTIES::TransferDataToWindow().

◆ IsOnCopperLayer()

virtual bool BOARD_ITEM::IsOnCopperLayer ( ) const

inlinevirtualinherited

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

Reimplemented in PAD, PCB_TRACK, and ZONE.

Definition at line 123 of file board_item.h.

 {
 return IsCopperLayer( GetLayer() );
 }

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

Referenced by CN_CONNECTIVITY_ALGO::Add(), FOOTPRINT::CheckNetTies(), DRC_ENGINE::EvalRules(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_CONNECTED_ITEM::SetNetCode(), and PCB_CONTROL::UpdateMessagePanel().

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

Definition at line 245 of file board_item.h.

 {
 return m_layer == aLayer;
 }

References BOARD_ITEM::m_layer.

Referenced by DRC_TEST_PROVIDER_SOLDER_MASK::addItemToRTrees(), DRC_TEST_PROVIDER_SOLDER_MASK::checkMaskAperture(), CN_VISITOR::checkZoneItemConnection(), BOARD_ADAPTER::createLayers(), existsOnLayerFunc(), GENERAL_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), BOARD_INSPECTION_TOOL::InspectClearance(), isEdge(), PNS_KICAD_IFACE::IsItemVisible(), VIAPAD::IsOnLayer(), BOARD_COMMIT::Push(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), DRC_TEST_PROVIDER_PHYSICAL_CLEARANCE::Run(), PCB_EDIT_FRAME::SetActiveLayer(), PCB_BASE_EDIT_FRAME::ShowGraphicItemPropertiesDialog(), 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 LIB_TEXTBOX, SCH_FIELD, SCH_LABEL, SCH_SHEET, SCH_SHEET_PIN, SCH_SYMBOL, SCH_TEXT, and SCH_TEXTBOX.

Definition at line 420 of file eda_item.h.

420{ return false; }

Referenced by EDA_ITEM::Matches().

◆ IsRollover()

bool EDA_ITEM::IsRollover ( ) const

inlineinherited

Definition at line 110 of file eda_item.h.

 {
 return ( m_flags & ( IS_ROLLOVER | IS_MOVING ) ) == IS_ROLLOVER;
 }

References IS_MOVING, IS_ROLLOVER, and EDA_ITEM::m_flags.

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

◆ IsSelected()

bool EDA_ITEM::IsSelected ( ) const

inlineinherited

Definition at line 106 of file eda_item.h.

106{ return m_flags & SELECTED; }

References EDA_ITEM::m_flags, and SELECTED.

◆ IsShownAsBitmap()

bool EDA_ITEM::IsShownAsBitmap ( ) const

inlineinherited

Definition at line 173 of file eda_item.h.

173{ return m_flags & IS_SHOWN_AS_BITMAP; }

IS_SHOWN_AS_BITMAP

#define IS_SHOWN_AS_BITMAP

Definition: eda_item_flags.h:54

References IS_SHOWN_AS_BITMAP, and EDA_ITEM::m_flags.

◆ IsTented()

virtual bool BOARD_ITEM::IsTented ( ) const

inlinevirtualinherited

Reimplemented in PCB_VIA.

Definition at line 133 of file board_item.h.

 {
 return false;
 }

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

inlineoverridevirtual

Check whether the item is one of the listed types.

Parameters

aScanTypes List of item types

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

Reimplemented from EDA_ITEM.

Definition at line 51 of file pcb_text.h.

 {
 if( BOARD_ITEM::IsType( aScanTypes ) )
 return true;
 
 for( KICAD_T scanType : aScanTypes )
 {
 if( scanType == PCB_LOCATE_TEXT_T )
 return true;
 }
 
 return false;
 }

References EDA_ITEM::IsType(), and PCB_LOCATE_TEXT_T.

◆ IsVisible()

bool PCB_TEXT::IsVisible ( ) const

inlineoverridevirtual

Reimplemented from EDA_TEXT.

Definition at line 69 of file pcb_text.h.

69{ return true; }

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

 {
 for( const auto& it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
 testData,
 scanTypes ) == INSPECT_RESULT::QUIT )
 {
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
 }

References CONTINUE, QUIT, and 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 322 of file eda_item.h.

 {
 for( const auto& it : aList )
 {
 if( static_cast<EDA_ITEM*>( it )->Visit( inspector,
 testData,
 scanTypes ) == INSPECT_RESULT::QUIT )
 {
 return INSPECT_RESULT::QUIT;
 }
 }
 
 return INSPECT_RESULT::CONTINUE;
 }

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

◆ layerMaskDescribe()

wxString BOARD_ITEM::layerMaskDescribe ( ) const

protectedvirtualinherited

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

Reimplemented in PCB_VIA.

Definition at line 106 of file board_item.cpp.

{
 const BOARD* board = GetBoard();
 LSET layers = GetLayerSet();
 
 // Try to be smart and useful. Check all copper first.
 if( layers[F_Cu] && layers[B_Cu] )
 return _( "all copper layers" );
 
 LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
 LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
 
 for( LSET testLayers : { copperLayers, techLayers, layers } )
 {
 for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
 {
 if( testLayers[ bit ] )
 {
 wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
 
 if( testLayers.count() > 1 )
 layerInfo << wxS( " " ) + _( "and others" );
 
 return layerInfo;
 }
 }
 }
 
 // No copper, no technicals: no layer
 return _( "no layers" );
}

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

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

◆ MapHorizJustify()

GR_TEXT_H_ALIGN_T EDA_TEXT::MapHorizJustify ( int aHorizJustify )

staticinherited

Definition at line 62 of file eda_text.cpp.

{
 wxASSERT( aHorizJustify >= GR_TEXT_H_ALIGN_LEFT && aHorizJustify <= GR_TEXT_H_ALIGN_RIGHT );
 
 if( aHorizJustify > GR_TEXT_H_ALIGN_RIGHT )
 return GR_TEXT_H_ALIGN_RIGHT;
 
 if( aHorizJustify < GR_TEXT_H_ALIGN_LEFT )
 return GR_TEXT_H_ALIGN_LEFT;
 
 return static_cast<GR_TEXT_H_ALIGN_T>( aHorizJustify );
}

References GR_TEXT_H_ALIGN_LEFT, and GR_TEXT_H_ALIGN_RIGHT.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ MapVertJustify()

GR_TEXT_V_ALIGN_T EDA_TEXT::MapVertJustify ( int aVertJustify )

staticinherited

Definition at line 76 of file eda_text.cpp.

{
 wxASSERT( aVertJustify >= GR_TEXT_V_ALIGN_TOP && aVertJustify <= GR_TEXT_V_ALIGN_BOTTOM );
 
 if( aVertJustify > GR_TEXT_V_ALIGN_BOTTOM )
 return GR_TEXT_V_ALIGN_BOTTOM;
 
 if( aVertJustify < GR_TEXT_V_ALIGN_TOP )
 return GR_TEXT_V_ALIGN_TOP;
 
 return static_cast<GR_TEXT_V_ALIGN_T>( aVertJustify );
}

References GR_TEXT_V_ALIGN_BOTTOM, and GR_TEXT_V_ALIGN_TOP.

Referenced by DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ Matches() [1/2]

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

inlineoverridevirtual

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 71 of file pcb_text.h.

 {
 return BOARD_ITEM::Matches( GetShownText(), aSearchData );
 }

References GetShownText(), and EDA_ITEM::Matches().

Referenced by DIALOG_FIND::search(), and TEXT_SEARCH_HANDLER::Search().

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

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 
 // Don't match if searching for replaceable item and the item doesn't support text replace.
 if( aSearchData.searchAndReplace && !IsReplaceable() )
 return false;
 
 if( !aSearchData.matchCase )
 {
 text.MakeUpper();
 searchText.MakeUpper();
 }
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 return false;
 
 ii = next;
 next += searchText.length();
 
 bool startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 bool endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 
 if( startOK && endOK )
 return true;
 else
 ii++;
 }
 
 return false;
 }
 else if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WILDCARD )
 {
 return text.Matches( searchText );
 }
 else
 {
 return text.Find( searchText ) != wxNOT_FOUND;
 }
}

References EDA_SEARCH_DATA::findString, EDA_ITEM::IsReplaceable(), EDA_SEARCH_DATA::matchCase, EDA_SEARCH_DATA::matchMode, next(), EDA_SEARCH_DATA::searchAndReplace, text, WHOLEWORD, and WILDCARD.

◆ Mirror()

void PCB_TEXT::Mirror	(	const VECTOR2I &	aCentre,
		bool	aMirrorAroundXAxis
	)

Definition at line 197 of file pcb_text.cpp.

{
 // the position and justification are mirrored, but not the text itself
 
 if( aMirrorAroundXAxis )
 {
 if( GetTextAngle() == ANGLE_VERTICAL )
 SetHorizJustify( (GR_TEXT_H_ALIGN_T) -GetHorizJustify() );
 
 SetTextY( MIRRORVAL( GetTextPos().y, aCentre.y ) );
 }
 else
 {
 if( GetTextAngle() == ANGLE_HORIZONTAL )
 SetHorizJustify( (GR_TEXT_H_ALIGN_T) -GetHorizJustify() );
 
 SetTextX( MIRRORVAL( GetTextPos().x, aCentre.x ) );
 }
}

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), MIRRORVAL(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetTextX(), EDA_TEXT::SetTextY(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ Move()

void PCB_TEXT::Move ( const VECTOR2I & aMoveVector )

inlineoverridevirtual

Move this object.

Parameters

aMoveVector the move vector for this object.

Reimplemented from BOARD_ITEM.

Definition at line 86 of file pcb_text.h.

 {
 EDA_TEXT::Offset( aMoveVector );
 }

References EDA_TEXT::Offset().

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), and ALTIUM_PCB::HelperParseDimensions6Radial().

◆ Offset()

void EDA_TEXT::Offset ( const VECTOR2I & aOffset )

inherited

Definition at line 389 of file eda_text.cpp.

{
 m_pos += aOffset;
 
 for( std::unique_ptr<KIFONT::GLYPH>& glyph : m_render_cache )
 static_cast<KIFONT::OUTLINE_GLYPH*>( glyph.get() )->Move( aOffset );
 
 m_bounding_box_cache_valid = false;
}

References EDA_TEXT::m_bounding_box_cache_valid, EDA_TEXT::m_pos, and EDA_TEXT::m_render_cache.

Referenced by CADSTAR_ARCHIVE_PARSER::FixTextPositionNoAlignment(), SCH_FIELD::Move(), SCH_SHEET_PIN::Move(), SCH_TEXT::Move(), SCH_TEXTBOX::Move(), FP_TEXT::Move(), FP_TEXTBOX::Move(), Move(), PCB_TEXTBOX::Move(), PCB_DIMENSION_BASE::Move(), LIB_FIELD::Offset(), LIB_TEXT::Offset(), FP_TEXT::SetDrawCoord(), EDA_TEXT::SetTextPos(), EDA_TEXT::SetTextX(), EDA_TEXT::SetTextY(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_LABEL_PROPERTIES::TransferDataToWindow(), DIALOG_SHEET_PROPERTIES::TransferDataToWindow(), and DIALOG_SYMBOL_PROPERTIES::TransferDataToWindow().

◆ operator<()

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

inherited

Test if another item is less than this object.

Parameters

aItem - Item to compare against.

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

Definition at line 231 of file eda_item.cpp.

{
 wxFAIL_MSG( wxString::Format( wxT( "Less than operator not defined for item type %s." ),
  GetClass() ) );
 
 return false;
}

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

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

{
 if( IsMultilineAllowed() )
 {
 std::vector<VECTOR2I> positions;
 wxArrayString strings;
 wxStringSplit( GetShownText(), strings, '\n' );
 
 positions.reserve( strings.Count() );
 
 GetLinePositions( positions, (int) strings.Count() );
 
 for( unsigned ii = 0; ii < strings.Count(); ii++ )
 printOneLineOfText( aSettings, aOffset, aColor, aFillMode, strings[ii], positions[ii] );
 }
 else
 {
 printOneLineOfText( aSettings, aOffset, aColor, aFillMode, GetShownText(), GetDrawPos() );
 }
}

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

{
 wxDC* DC = aSettings->GetPrintDC();
 int penWidth = GetEffectiveTextPenWidth( aSettings->GetDefaultPenWidth() );
 
 if( aFillMode == SKETCH )
 penWidth = -penWidth;
 
 VECTOR2I size = GetTextSize();
 
 if( IsMirrored() )
 size.x = -size.x;
 
 KIFONT::FONT* font = GetFont();
 
 if( !font )
 font = KIFONT::FONT::GetFont( aSettings->GetDefaultFont(), IsBold(), IsItalic() );
 
 GRPrintText( DC, aOffset + aPos, aColor, aText, GetDrawRotation(), size, GetHorizJustify(),
 GetVertJustify(), penWidth, IsItalic(), IsBold(), font );
}

References KIGFX::RENDER_SETTINGS::GetDefaultFont(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetEffectiveTextPenWidth(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), 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 336 of file eda_text.h.

336{ m_hyperlink = wxEmptyString; }

References EDA_TEXT::m_hyperlink.

◆ RenderAsBitmap()

virtual bool EDA_ITEM::RenderAsBitmap ( double aWorldScale ) const

inlinevirtualinherited

Reimplemented in SCH_ITEM.

Definition at line 163 of file eda_item.h.

163{ return false; }

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

{
 bool retval = EDA_ITEM::Replace( aSearchData, m_text );
 
 cacheShownText();
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
 
 return retval;
}

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

Referenced by LIB_TEXTBOX::Replace(), 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 LIB_TEXTBOX, SCH_LABEL_BASE, SCH_PIN, SCH_TEXT, SCH_TEXTBOX, SCH_FIELD, and SCH_SHEET_PIN.

Definition at line 409 of file eda_item.h.

 {
 return false;
 }

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

{
 wxString text = aText;
 wxString searchText = aSearchData.findString;
 wxString result;
 bool replaced = false;
 
 if( !aSearchData.matchCase )
 {
 text = text.Upper();
 searchText = searchText.Upper();
 }
 
 int ii = 0;
 
 while( ii < (int) text.length() )
 {
 int next = text.find( searchText, ii );
 
 if( next == wxNOT_FOUND )
 {
 result += aText.Mid( ii, wxString::npos );
 break;
 }
 
 if( next > ii )
 result += aText.Mid( ii, next - ii );
 
 ii = next;
 next += searchText.length();
 
 bool startOK;
 bool endOK;
 
 if( aSearchData.matchMode == EDA_SEARCH_MATCH_MODE::WHOLEWORD )
 {
 startOK = ( ii == 0 || !wxIsalnum( text.GetChar( ii - 1 ) ) );
 endOK = ( next == (int) text.length() || !wxIsalnum( text.GetChar( next ) ) );
 }
 else
 {
 startOK = true;
 endOK = true;
 }
 
 if( startOK && endOK )
 {
 result += aSearchData.replaceString;
 replaced = true;
 ii = next;
 }
 else
 {
 result += aText.GetChar( ii );
 ii++;
 }
 }
 
 aText = result;
 return replaced;
}

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

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

◆ Rotate()

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

overridevirtual

Rotate this object.

Parameters

aRotCentre the rotation center point.

Reimplemented from BOARD_ITEM.

Definition at line 185 of file pcb_text.cpp.

{
 VECTOR2I pt = GetTextPos();
 RotatePoint( pt, aRotCentre, aAngle );
 SetTextPos( pt );
 
 EDA_ANGLE new_angle = GetTextAngle() + aAngle;
 new_angle.Normalize180();
 SetTextAngle( new_angle );
}

References EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextPos(), EDA_ANGLE::Normalize180(), RotatePoint(), EDA_TEXT::SetTextAngle(), and EDA_TEXT::SetTextPos().

◆ Set() [1/3]

template<typename T >

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

inlineinherited

Definition at line 66 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 TYPE_ID thisType = TYPE_HASH( *this );
 PROPERTY_BASE* prop = propMgr.GetProperty( thisType, aProperty );
 void* object = nullptr;
 
 if( prop )
 {
 object = propMgr.TypeCast( this, thisType, prop->OwnerHash() );
 
 if( object )
 prop->set<T>( object, aValue );
 }
 
 return object != nullptr;
 }

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

◆ Set() [2/3]

template<typename T >

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

inlineinherited

Definition at line 54 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->set<T>( object, aValue );
 
 return object != nullptr;
 }

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

◆ Set() [3/3]

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

inlineinherited

Definition at line 42 of file inspectable.h.

 {
 PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
 void* object = propMgr.TypeCast( this, TYPE_HASH( *this ), aProperty->OwnerHash() );
 
 if( object )
 aProperty->setter( object, aValue );
 
 return object != nullptr;
 }

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

Referenced by PCB_PROPERTIES_PANEL::valueChanged().

◆ SetAttributes() [1/2]

void EDA_TEXT::SetAttributes ( const EDA_TEXT & aSrc )

inherited

Set the text attributes from another instance.

Definition at line 264 of file eda_text.cpp.

{
 m_attributes = aSrc.m_attributes;
 m_pos = aSrc.m_pos;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by LIB_TEXT::Clone(), LIB_FIELD::Copy(), SCH_FIELD::ImportValues(), SYMBOL_EDIT_FRAME::LoadSymbolFromSchematic(), DIALOG_UPDATE_SYMBOL_FIELDS::onOkButtonClicked(), LIB_FIELD::operator=(), DRAWING_TOOL::PlaceText(), DIALOG_CHANGE_SYMBOLS::processSymbol(), and CLIPBOARD_IO::SaveSelection().

◆ SetAttributes() [2/2]

void EDA_TEXT::SetAttributes ( const TEXT_ATTRIBUTES & aTextAttrs )

inlineinherited

Definition at line 171 of file eda_text.h.

171{ m_attributes = aTextAttrs; }

References EDA_TEXT::m_attributes.

◆ SetBold()

void EDA_TEXT::SetBold ( bool aBold )

inherited

Definition at line 209 of file eda_text.cpp.

{
 m_attributes.m_Bold = aBold;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by SCH_ALTIUM_PLUGIN::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_LABEL_PROPERTIES::OnAddField(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseLabel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetBrightened()

void EDA_ITEM::SetBrightened ( )

inlineinherited

Definition at line 116 of file eda_item.h.

116{ SetFlags( BRIGHTENED ); }

EDA_ITEM::SetFlags

void SetFlags(EDA_ITEM_FLAGS aMask)

Definition: eda_item.h:139

References BRIGHTENED, and EDA_ITEM::SetFlags().

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

◆ SetFlags()

void EDA_ITEM::SetFlags ( EDA_ITEM_FLAGS aMask )

inlineinherited

Definition at line 139 of file eda_item.h.

139{ m_flags |= aMask; }

References EDA_ITEM::m_flags.

◆ SetFont()

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

inherited

Definition at line 331 of file eda_text.cpp.

{
 m_attributes.m_Font = aFont;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

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

199{ m_forceVisible = aEnable; }

References EDA_ITEM::m_forceVisible.

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

◆ SetHorizJustify()

void EDA_TEXT::SetHorizJustify ( GR_TEXT_H_ALIGN_T aType )

inherited

Definition at line 240 of file eda_text.cpp.

{
 m_attributes.m_Halign = aType;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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(), GRAPHICS_IMPORTER_PCBNEW::AddText(), SCH_ALTIUM_PLUGIN::AddTextBox(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXTBOX::FP_TEXTBOX(), ALTIUM_PCB::HelperParseDimensions6Radial(), AUTOPLACER::justifyField(), FP_TEXT::KeepUpright(), LIB_TEXTBOX::LIB_TEXTBOX(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), SCH_EAGLE_PLUGIN::loadFrame(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_EDIT_TOOL::Mirror(), FP_TEXT::Mirror(), Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXTBOX::MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), LIB_TEXTBOX::MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), PCB_TEXTBOX::PCB_TEXTBOX(), LIB_TEXT::Rotate(), SCH_TEXTBOX::SCH_TEXTBOX(), PCAD2KICAD::SetTextJustify(), SCH_TEXT::SetTextSpinStyle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ SetHyperlink()

void EDA_TEXT::SetHyperlink ( wxString aLink )

inlineinherited

Definition at line 335 of file eda_text.h.

335{ m_hyperlink = aLink; }

References EDA_TEXT::m_hyperlink.

Referenced by SCH_EDIT_TOOL::ChangeTextType(), EDA_TEXT_DESC::EDA_TEXT_DESC(), SCH_SEXPR_PARSER::parseEDA_TEXT(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetIsKnockout()

virtual void BOARD_ITEM::SetIsKnockout ( bool aKnockout )

inlinevirtualinherited

Definition at line 251 of file board_item.h.

251{ m_isKnockout = aKnockout; }

References BOARD_ITEM::m_isKnockout.

Referenced by PCB_TEXT_DESC::PCB_TEXT_DESC().

◆ SetIsShownAsBitmap()

void EDA_ITEM::SetIsShownAsBitmap ( bool aBitmap )

inlineinherited

Definition at line 165 of file eda_item.h.

 {
 if( aBitmap )
 SetFlags( IS_SHOWN_AS_BITMAP );
 else
 ClearFlags( IS_SHOWN_AS_BITMAP );
 }

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

◆ SetItalic()

void EDA_TEXT::SetItalic ( bool aItalic )

inherited

Definition at line 201 of file eda_text.cpp.

{
 m_attributes.m_Italic = aItalic;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by SCH_ALTIUM_PLUGIN::AddTextBox(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT_DESC::EDA_TEXT_DESC(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), SCH_LEGACY_PLUGIN_CACHE::loadField(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), SCH_LEGACY_PLUGIN::loadSymbol(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseLabel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), SCH_DRAWING_TOOLS::TwoClickPlace(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetKeepUpright()

void EDA_TEXT::SetKeepUpright ( bool aKeepUpright )

inherited

Definition at line 256 of file eda_text.cpp.

{
 m_attributes.m_KeepUpright = aKeepUpright;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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::PCB_FOOTPRINT::AddToBoard(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), PCB_BASE_FRAME::CreateNewFootprint(), FP_TEXT::FP_TEXT(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), and DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem().

◆ 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_GROUP, PCB_DIMENSION_BASE, and ZONE.

Definition at line 214 of file board_item.h.

 {
 m_layer = aLayer;
 }

References BOARD_ITEM::m_layer.

◆ SetLayerSet()

virtual void BOARD_ITEM::SetLayerSet ( LSET aLayers )

inlinevirtualinherited

Reimplemented in PAD, PCB_VIA, and ZONE.

Definition at line 193 of file board_item.h.

 {
 if( aLayers.count() == 1 )
 {
 SetLayer( aLayers.Seq()[0] );
 return;
 }
 
 wxFAIL_MSG( wxT( "Attempted to SetLayerSet() on a single-layer object." ) );
 
 // Derived classes which support multiple layers must implement this
 }

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

Referenced by PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ SetLineSpacing()

void EDA_TEXT::SetLineSpacing ( double aLineSpacing )

inherited

Definition at line 339 of file eda_text.cpp.

{
 m_attributes.m_LineSpacing = aLineSpacing;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by PCB_PARSER::parseEDA_TEXT(), and SCH_SEXPR_PARSER::parseEDA_TEXT().

◆ SetLocked()

virtual void BOARD_ITEM::SetLocked ( bool aLocked )

inlinevirtualinherited

◆ SetMirrored()

void EDA_TEXT::SetMirrored ( bool isMirrored )

inherited

Definition at line 224 of file eda_text.cpp.

{
 m_attributes.m_Mirrored = isMirrored;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), Flip(), PCB_TEXTBOX::Flip(), FP_TEXT::FP_TEXT(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), PCB_DIMENSION_BASE::Mirror(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ SetModified()

void EDA_ITEM::SetModified ( )

inherited

Definition at line 64 of file eda_item.cpp.

{
 SetFlags( IS_CHANGED );
 
 // If this a child object, then the parent modification state also needs to be set.
 if( m_parent )
 m_parent->SetModified();
}

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

Referenced by SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LEGACY_PLUGIN::loadZONE_CONTAINER(), SCH_LINE::Move(), SCH_SYMBOL::Move(), SCH_LINE::MoveEnd(), SCH_LINE::MoveStart(), LIB_PIN::MoveTo(), PCB_EDIT_FRAME::OpenProjectFiles(), ALTIUM_PCB::Parse(), SCH_ALTIUM_PLUGIN::ParseFileHeader(), PCB_PARSER::parseZONE(), LIB_SYMBOL::RemoveDrawItem(), SCH_SYMBOL::SetConvert(), SCH_SYMBOL::SetLibId(), EDA_ITEM::SetModified(), LIB_FIELD::SetName(), SCH_SYMBOL::SetTransform(), and SCH_SYMBOL::SetUnit().

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

{
 m_attributes.m_Multiline = aAllow;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by FP_TEXTBOX::FP_TEXTBOX(), LIB_TEXTBOX::LIB_TEXTBOX(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_TEXT(), PCB_TEXTBOX::PCB_TEXTBOX(), SCH_LABEL_BASE::SCH_LABEL_BASE(), SCH_TEXT::SCH_TEXT(), and SCH_TEXTBOX::SCH_TEXTBOX().

◆ SetParent()

virtual void EDA_ITEM::SetParent ( EDA_ITEM * aParent )

inlinevirtualinherited

Reimplemented in LIB_SYMBOL, and PCB_DIMENSION_BASE.

Definition at line 100 of file eda_item.h.

100{ m_parent = aParent; }

References EDA_ITEM::m_parent.

Referenced by BOARD::Add(), FOOTPRINT::Add(), FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), SCH_SHEET::AddPin(), PAD::AddPrimitive(), PAD::AddPrimitiveAnnotationBox(), PAD::AddPrimitiveArc(), PAD::AddPrimitiveCircle(), PAD::AddPrimitiveCurve(), PAD::AddPrimitivePoly(), PAD::AddPrimitiveRect(), PAD::AddPrimitiveSegment(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), SCH_SCREEN::Append(), LIB_FIELD::Copy(), SYMBOL_EDIT_FRAME::CreateNewSymbol(), SCH_DRAWING_TOOLS::createNewText(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), PCBNEW_JOBS_HANDLER::doFpExportSvg(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::ExchangeFootprint(), LIB_SYMBOL::Flatten(), FOOTPRINT::FOOTPRINT(), PCB_PLUGIN::FootprintSave(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), CADSTAR_SCH_ARCHIVE_LOADER::getKiCadSchText(), LIB_SYMBOL::LIB_SYMBOL(), SCH_LEGACY_PLUGIN_CACHE::loadAliases(), CADSTAR_SCH_ARCHIVE_LOADER::loadChildSheets(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), SCH_SEXPR_PLUGIN::loadHierarchy(), SCH_LEGACY_PLUGIN::loadHierarchy(), KI_TEST::LoadHierarchy(), LIB_SYMBOL::operator=(), FOOTPRINT::operator=(), PCB_PARSER::parseFOOTPRINT_unchecked(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_SEXPR_PARSER::ParseSymbol(), SCH_EDITOR_CONTROL::Paste(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), PCB_CONTROL::Paste(), pasteFootprintItemsToFootprintEditor(), BOARD_EDITOR_CONTROL::PlaceFootprint(), BACK_ANNOTATE::processNetNameChange(), BOARD_COMMIT::Push(), SCH_LIB_PLUGIN_CACHE::removeSymbol(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SaveCopyOfZones(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), CLIPBOARD_IO::SaveSelection(), SCH_SHEET_PIN::SCH_SHEET_PIN(), LIB_SYMBOL::SetFields(), PCB_DIMENSION_BASE::SetParent(), SCH_DRAWING_TOOLS::SingleClickPlace(), SCH_LINE_WIRE_BUS_TOOL::startSegments(), SCH_LABEL_BASE::SwapData(), SCH_SHEET::SwapData(), SCH_SYMBOL::SwapData(), BOARD_ITEM::SwapItemData(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), and SCH_DRAWING_TOOLS::TwoClickPlace().

◆ SetParentGroup()

void BOARD_ITEM::SetParentGroup ( PCB_GROUP * aGroup )

inlineinherited

Definition at line 71 of file board_item.h.

71{ m_group = aGroup; }

References BOARD_ITEM::m_group.

Referenced by PCB_GROUP::AddItem(), EDIT_TOOL::DragArcTrack(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), BOARD_COMMIT::makeImage(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_GROUP::RemoveItem(), BOARD_COMMIT::Revert(), PCB_BASE_EDIT_FRAME::saveCopyInUndoList(), SaveCopyOfZones(), BOARD_ITEM::SwapItemData(), and TEST_BOARD_ITEM_FIXTURE::~TEST_BOARD_ITEM_FIXTURE().

◆ SetPosition()

virtual void PCB_TEXT::SetPosition ( const VECTOR2I & aPos )

inlineoverridevirtual

Reimplemented from EDA_ITEM.

Definition at line 81 of file pcb_text.h.

 {
 EDA_TEXT::SetTextPos( aPos );
 }

References EDA_TEXT::SetTextPos().

Referenced by ALTIUM_PCB::ConvertTexts6ToBoardItemOnLayer(), DRAWING_TOOL::DrawBoardCharacteristics(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), ALTIUM_PCB::HelperParseDimensions6Radial(), EAGLE_PLUGIN::loadPlain(), and PCB_POINT_EDITOR::updateItem().

◆ SetSelected()

void EDA_ITEM::SetSelected ( )

inlineinherited

Definition at line 115 of file eda_item.h.

115{ SetFlags( SELECTED ); }

References SELECTED, and EDA_ITEM::SetFlags().

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

◆ SetState()

void EDA_ITEM::SetState	(	EDA_ITEM_FLAGS	type,
		bool	state
	)

inlineinherited

Definition at line 128 of file eda_item.h.

 {
 if( state )
 m_status |= type; // state = ON or OFF
 else
 m_status &= ~type;
 }

References EDA_ITEM::m_status.

Referenced by LEGACY_PLUGIN::loadTrackList(), and TRACKS_CLEANER::mergeCollinearSegments().

◆ SetStatus()

void EDA_ITEM::SetStatus ( EDA_ITEM_FLAGS aStatus )

inlineinherited

Definition at line 137 of file eda_item.h.

137{ m_status = aStatus; }

References EDA_ITEM::m_status.

Referenced by BOARD_NETLIST_UPDATER::UpdateNetlist().

◆ SetStroke()

void BOARD_ITEM::SetStroke ( const STROKE_PARAMS & aStroke )

virtualinherited

Reimplemented in PCB_SHAPE.

Definition at line 88 of file board_item.cpp.

{
 wxCHECK( false, /* void */ );
}

◆ SetText()

void EDA_TEXT::SetText ( const wxString & aText )

virtualinherited

Definition at line 163 of file eda_text.cpp.

{
 m_text = aText;
 
 cacheShownText();
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

◆ SetTextAngle()

void EDA_TEXT::SetTextAngle ( const EDA_ANGLE & aAngle )

virtualinherited

Definition at line 193 of file eda_text.cpp.

{
 m_attributes.m_Angle = aAngle;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToBoardItemOnLayer(), ALTIUM_PCB::ConvertTexts6ToFootprintItemOnLayer(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), eagleToKicadAlignment(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), Flip(), PCB_TEXTBOX::Flip(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), LIB_FIELD::Init(), FP_TEXT::KeepUpright(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), PCB_DIMENSION_BASE::Mirror(), DIALOG_LABEL_PROPERTIES::OnAddField(), DIALOG_SHEET_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_ALTIUM_PLUGIN::ParsePowerPort(), SCH_EDIT_TOOL::Rotate(), SCH_TEXTBOX::Rotate(), LIB_TEXTBOX::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), FP_TEXTBOX::Rotate(), PCB_DIMENSION_BASE::Rotate(), Rotate(), PCB_TEXTBOX::Rotate(), SCH_TEXTBOX::Rotate90(), EDA_TEXT::SetTextAngleDegrees(), SCH_TEXT::SetTextSpinStyle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), PCB_DIM_ALIGNED::updateText(), PCB_DIM_ORTHOGONAL::updateText(), PCB_DIM_RADIAL::updateText(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ SetTextAngleDegrees()

void EDA_TEXT::SetTextAngleDegrees ( double aOrientation )

inlineinherited

Definition at line 123 of file eda_text.h.

 {
 SetTextAngle( EDA_ANGLE( aOrientation, DEGREES_T ) );
 }

References DEGREES_T, and EDA_TEXT::SetTextAngle().

Referenced by EDA_TEXT_DESC::EDA_TEXT_DESC().

◆ SetTextColor()

void EDA_TEXT::SetTextColor ( const COLOR4D & aColor )

inlineinherited

Definition at line 204 of file eda_text.h.

204{ m_attributes.m_Color = aColor; }

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

Referenced by DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseHarnessType(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_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 363 of file eda_text.cpp.

{
 m_attributes.m_Size.y = aHeight;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), and FABMASTER::loadOutline().

◆ SetTextPos()

void EDA_TEXT::SetTextPos ( const VECTOR2I & aPoint )

inherited

Definition at line 371 of file eda_text.cpp.

{
 Offset( VECTOR2I( aPoint.x - m_pos.x, aPoint.y - m_pos.y ) );
}

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyToLibraryFieldAttribute(), LIB_FIELD::BeginEdit(), LIB_TEXT::BeginEdit(), LIB_FIELD::CalcEdit(), LIB_TEXT::CalcEdit(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), FP_TEXT::FP_TEXT(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), CADSTAR_PCB_ARCHIVE_LOADER::loadDimensions(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_DIMENSION_BASE::Mirror(), LIB_FIELD::MoveTo(), LIB_TEXT::MoveTo(), LIB_TEXT::NormalizeJustification(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), SCH_SEXPR_PARSER::parseSchText(), DRAWING_TOOL::PlaceText(), DIALOG_CHANGE_SYMBOLS::processSymbol(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), Rotate(), SCH_FIELD::SCH_FIELD(), SCH_SHEET_PIN::SCH_SHEET_PIN(), SCH_TEXT::SCH_TEXT(), FP_TEXT::SetDrawCoord(), DS_DRAW_ITEM_TEXT::SetPosition(), FP_TEXT::SetPosition(), SetPosition(), SCH_FIELD::SetPosition(), SCH_TEXT::SetPosition(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), SCH_SYMBOL::UpdateFields(), PCB_DIM_ALIGNED::updateText(), and PCB_DIM_ORTHOGONAL::updateText().

◆ SetTextSize()

void EDA_TEXT::SetTextSize ( const VECTOR2I & aNewSize )

inherited

Definition at line 347 of file eda_text.cpp.

{
 m_attributes.m_Size = aNewSize;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), SCH_EAGLE_PLUGIN::addImplicitConnections(), SCH_ALTIUM_PLUGIN::AddTextBox(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), SCH_EDIT_TOOL::ChangeTextType(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), MICROWAVE_TOOL::createBaseFootprint(), PCB_BASE_FRAME::CreateNewFootprint(), SCH_DRAWING_TOOLS::createNewText(), SCH_DRAWING_TOOLS::createSheetPin(), SCH_LINE_WIRE_BUS_TOOL::doUnfoldBus(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), DRAWING_TOOL::DrawDimension(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), DS_DRAW_ITEM_TEXT::DS_DRAW_ITEM_TEXT(), EDA_TEXT::EDA_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), LIB_TEXT::LIB_TEXT(), LIB_TEXTBOX::LIB_TEXTBOX(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EAGLE_PLUGIN::loadFrame(), LEGACY_PLUGIN::loadMODULE_TEXT(), CADSTAR_SCH_ARCHIVE_LOADER::loadNets(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), CADSTAR_SCH_ARCHIVE_LOADER::loadSchematicSymbolInstances(), SCH_LEGACY_PLUGIN::loadSheet(), SCH_LEGACY_PLUGIN::loadSymbol(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_LIB_SYMBOL_PROPERTIES::OnAddField(), DIALOG_SYMBOL_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), SCH_ALTIUM_PLUGIN::ParseHarnessPort(), SCH_ALTIUM_PLUGIN::ParseLabel(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), BACK_ANNOTATE::processNetNameChange(), PCB_DIMENSION_BASE::SetTextSize(), PCAD2KICAD::SetTextSizeFromStrokeFontHeight(), PCAD2KICAD::SetTextSizeFromTrueTypeFontHeight(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_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 185 of file eda_text.cpp.

{
 m_attributes.m_StrokeWidth = aWidth;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by CADSTAR_PCB_ARCHIVE_LOADER::addAttribute(), GRAPHICS_IMPORTER_PCBNEW::AddText(), PCAD2KICAD::PCB_FOOTPRINT::AddToBoard(), PCAD2KICAD::PCB_TEXT::AddToBoard(), CADSTAR_PCB_ARCHIVE_LOADER::applyDimensionSettings(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), 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(), FP_TEXT::FP_TEXT(), ALTIUM_PCB::HelperParseDimensions6Linear(), ALTIUM_PCB::HelperParseDimensions6Radial(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), LEGACY_PLUGIN::loadMODULE_TEXT(), FABMASTER::loadOutline(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_EAGLE_PLUGIN::loadTextAttributes(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHEET_PIN_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ SetTextWidth()

void EDA_TEXT::SetTextWidth ( int aWidth )

inherited

Definition at line 355 of file eda_text.cpp.

{
 m_attributes.m_Size.x = aWidth;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

Referenced by GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), EDA_TEXT_DESC::EDA_TEXT_DESC(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), FABMASTER::loadFootprints(), FABMASTER::loadGraphics(), and FABMASTER::loadOutline().

◆ SetTextX()

void EDA_TEXT::SetTextX ( int aX )

inherited

Definition at line 377 of file eda_text.cpp.

{
 Offset( VECTOR2I( aX - m_pos.x, 0 ) );
}

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

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), Flip(), FP_TEXT::Mirror(), Mirror(), LIB_FIELD::MirrorHorizontal(), LIB_TEXT::MirrorHorizontal(), SCH_SHEET_PIN::MirrorHorizontally(), SCH_TEXT::MirrorHorizontally(), and SCH_SHEET_PIN::SetSide().

◆ SetTextY()

void EDA_TEXT::SetTextY ( int aY )

inherited

Definition at line 383 of file eda_text.cpp.

{
 Offset( VECTOR2I( 0, aY - m_pos.y ) );
}

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

Referenced by SCH_SHEET_PIN::ConstrainOnEdge(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), Flip(), FP_TEXT::Mirror(), Mirror(), LIB_FIELD::MirrorVertical(), LIB_TEXT::MirrorVertical(), SCH_SHEET_PIN::MirrorVertically(), SCH_TEXT::MirrorVertically(), and SCH_SHEET_PIN::SetSide().

◆ SetupRenderCache()

void EDA_TEXT::SetupRenderCache	(	const wxString &	aResolvedText,
		const EDA_ANGLE &	aAngle
	)

inherited

Definition at line 483 of file eda_text.cpp.

{
 m_render_cache_text = aResolvedText;
 m_render_cache_angle = aAngle;
 m_render_cache.clear();
}

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

◆ SetVertJustify()

void EDA_TEXT::SetVertJustify ( GR_TEXT_V_ALIGN_T aType )

inherited

Definition at line 248 of file eda_text.cpp.

{
 m_attributes.m_Valign = aType;
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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(), GRAPHICS_IMPORTER_PCBNEW::AddText(), CADSTAR_SCH_ARCHIVE_LOADER::applyTextSettings(), ALTIUM_PCB::ConvertTexts6ToEdaTextSettings(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), eagleToKicadAlignment(), EDA_TEXT_DESC::EDA_TEXT_DESC(), FP_TEXTBOX::FP_TEXTBOX(), ALTIUM_PCB::HelperParseDimensions6Radial(), AUTOPLACER::justifyField(), LIB_TEXTBOX::LIB_TEXTBOX(), SCH_LEGACY_PLUGIN_CACHE::loadField(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), SCH_EAGLE_PLUGIN::loadFrame(), LEGACY_PLUGIN::loadMODULE_TEXT(), LEGACY_PLUGIN::loadPCB_TEXT(), EAGLE_PLUGIN::loadPlain(), SCH_LEGACY_PLUGIN::loadSymbol(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), SCH_EDIT_TOOL::Mirror(), LIB_TEXT::MirrorHorizontal(), LIB_TEXT::MirrorVertical(), EAGLE_PLUGIN::orientFPText(), EAGLE_PLUGIN::packageText(), PCB_PARSER::parseEDA_TEXT(), SCH_SEXPR_PARSER::parseEDA_TEXT(), PCB_TEXTBOX::PCB_TEXTBOX(), LIB_TEXT::Rotate(), SCH_GLOBALLABEL::SCH_GLOBALLABEL(), SCH_TEXTBOX::SCH_TEXTBOX(), PCAD2KICAD::SetTextJustify(), SCH_TEXT::SetTextSpinStyle(), SCH_GLOBALLABEL::SetTextSpinStyle(), SCH_HIERLABEL::SetTextSpinStyle(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_FIELD_PROPERTIES::UpdateField(), and DIALOG_SCH_FIELD_PROPERTIES::UpdateField().

◆ SetVisible()

void PCB_TEXT::SetVisible ( bool aVisible )

inlineoverridevirtual

PCB_TEXTs are always visible:

Reimplemented from EDA_TEXT.

Definition at line 68 of file pcb_text.h.

68{ /* do nothing */}

◆ SetX()

void BOARD_ITEM::SetX ( int aX )

inlineinherited

Definition at line 98 of file board_item.h.

 {
 VECTOR2I p( aX, GetY() );
 SetPosition( p );
 }

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

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

◆ SetY()

void BOARD_ITEM::SetY ( int aY )

inlineinherited

Definition at line 104 of file board_item.h.

 {
 VECTOR2I p( GetX(), aY );
 SetPosition( p );
 }

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

Referenced by BOARD_ITEM_DESC::BOARD_ITEM_DESC(), and TRACK_VIA_DESC::TRACK_VIA_DESC().

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

438{ return *aLeft < *aRight; }

◆ SwapAttributes()

void EDA_TEXT::SwapAttributes ( EDA_TEXT & aTradingPartner )

inherited

Swap the text attributes of the two involved instances.

Definition at line 284 of file eda_text.cpp.

{
 std::swap( m_attributes, aTradingPartner.m_attributes );
 std::swap( m_pos, aTradingPartner.m_pos );
 
 ClearRenderCache();
 aTradingPartner.ClearRenderCache();
 
 m_bounding_box_cache_valid = false;
 aTradingPartner.m_bounding_box_cache_valid = false;
}

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_TEXT::swapData ( BOARD_ITEM * aImage )

overrideprotectedvirtual

Reimplemented from BOARD_ITEM.

Definition at line 258 of file pcb_text.cpp.

{
 assert( aImage->Type() == PCB_TEXT_T );
 
 std::swap( *((PCB_TEXT*) this), *((PCB_TEXT*) aImage) );
}

References PCB_TEXT_T, and EDA_ITEM::Type().

◆ SwapItemData()

void BOARD_ITEM::SwapItemData ( BOARD_ITEM * aImage )

inherited

Swap data between aItem and aImage.

aItem and aImage should have the same type.

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

Parameters

aImage the item image which contains data to swap.

Definition at line 166 of file board_item.cpp.

{
 if( aImage == nullptr )
 return;
 
 EDA_ITEM* parent = GetParent();
 PCB_GROUP* group = GetParentGroup();
 
 SetParentGroup( nullptr );
 aImage->SetParentGroup( nullptr );
 swapData( aImage );
 
 // Restore pointers to be sure they are not broken
 SetParent( parent );
 SetParentGroup( group );
}

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

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

◆ SwapText()

void EDA_TEXT::SwapText ( EDA_TEXT & aTradingPartner )

inherited

Definition at line 273 of file eda_text.cpp.

{
 std::swap( m_text, aTradingPartner.m_text );
 std::swap( m_shown_text, aTradingPartner.m_shown_text );
 std::swap( m_shown_text_has_text_var_refs, aTradingPartner.m_shown_text_has_text_var_refs );
 
 ClearRenderCache();
 m_bounding_box_cache_valid = false;
}

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

overridevirtual

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

{
 BOX2I rect = aRect;
 
 rect.Inflate( aAccuracy );
 
 if( aContains )
 return rect.Contains( GetBoundingBox() );
 
 return rect.Intersects( GetBoundingBox() );
}

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

◆ TextHitTest() [2/2]

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

overridevirtual

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

{
 if( IsKnockout() )
 {
 SHAPE_POLY_SET poly;
 
 TransformBoundingBoxToPolygon( &poly, getKnockoutMargin());
 
 return poly.Collide( aPoint, aAccuracy );
 }
 else
 {
 return EDA_TEXT::TextHitTest( aPoint, aAccuracy );
 }
}

References SHAPE_POLY_SET::Collide(), getKnockoutMargin(), BOARD_ITEM::IsKnockout(), EDA_TEXT::TextHitTest(), and EDA_TEXT::TransformBoundingBoxToPolygon().

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

◆ TransformBoundingBoxToPolygon()

void EDA_TEXT::TransformBoundingBoxToPolygon	(	SHAPE_POLY_SET *	aBuffer,
		int	aClearance
	)		const

inherited

Convert the text bounding box to a rectangular polygon depending on the text orientation, the bounding box is not always horizontal or vertical.

Used in filling zones calculations Circles and arcs are approximated by segments

Parameters

aBuffer	a buffer to store the polygon.
aClearance	the clearance around the text bounding box to the real clearance value (usually near from 1.0).

Definition at line 945 of file eda_text.cpp.

{
 if( GetText().Length() == 0 )
 return;
 
 VECTOR2I corners[4]; // Buffer of polygon corners
 BOX2I rect = GetTextBox();
 
 // TrueType bounding boxes aren't guaranteed to include all descenders, diacriticals, etc.
 // Since we use this for zone knockouts and DRC, we need something more accurate.
 if( getDrawFont()->IsOutline() )
 rect = GetEffectiveTextShape( false, false )->BBox();
 
 rect.Inflate( aClearance );
 
 corners[0].x = rect.GetOrigin().x;
 corners[0].y = rect.GetOrigin().y;
 corners[1].y = corners[0].y;
 corners[1].x = rect.GetRight();
 corners[2].x = corners[1].x;
 corners[2].y = rect.GetBottom();
 corners[3].y = corners[2].y;
 corners[3].x = corners[0].x;
 
 aBuffer->NewOutline();
 
 for( VECTOR2I& corner : corners )
 {
 RotatePoint( corner, GetDrawPos(), GetDrawRotation() );
 
 aBuffer->Append( corner.x, corner.y );
 }
}

References SHAPE_POLY_SET::Append(), BOX2< Vec >::GetBottom(), EDA_TEXT::getDrawFont(), EDA_TEXT::GetDrawPos(), EDA_TEXT::GetDrawRotation(), EDA_TEXT::GetEffectiveTextShape(), BOX2< Vec >::GetOrigin(), BOX2< Vec >::GetRight(), EDA_TEXT::GetText(), EDA_TEXT::GetTextBox(), BOX2< Vec >::Inflate(), SHAPE_POLY_SET::NewOutline(), RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOARD_ADAPTER::addText(), KIGFX::PCB_PAINTER::draw(), FP_TEXT::GetEffectiveShape(), GetEffectiveShape(), BRDITEMS_PLOTTER::PlotPcbText(), PNS_KICAD_IFACE_BASE::syncTextItem(), TextHitTest(), FP_TEXT::TransformShapeToPolygon(), and TransformShapeToPolygon().

◆ TransformShapeToPolygon()

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

overridevirtual

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

{
 EDA_TEXT::TransformBoundingBoxToPolygon( &aBuffer, aClearance );
}

References EDA_TEXT::TransformBoundingBoxToPolygon().

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

◆ TransformTextToPolySet()

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

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

Circles and arcs are approximated by segments. @aBuffer = SHAPE_POLY_SET to store the polygon corners @aClearance = the clearance around the text @aError = the maximum error to allow when approximating curves

Definition at line 291 of file pcb_text.cpp.

{
 KIGFX::GAL_DISPLAY_OPTIONS empty_opts;
 KIFONT::FONT* font = getDrawFont();
 int penWidth = GetEffectiveTextPenWidth();
 
 // The polygonal shape of a text can have many basic shapes, so combining these shapes can
 // be very useful to create a final shape with a lot less vertices to speedup calculations.
 // Simplify shapes is not usually always efficient, but in this case it is.
 SHAPE_POLY_SET buffer;
 
 CALLBACK_GAL callback_gal( empty_opts,
 // Stroke callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
 {
 TransformOvalToPolygon( aBuffer, aPt1, aPt2, penWidth + ( 2 * aClearance ),
 aError, ERROR_INSIDE );
 },
 // Triangulation callback
 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2, const VECTOR2I& aPt3 )
 {
 buffer.NewOutline();
 
 for( const VECTOR2I& point : { aPt1, aPt2, aPt3 } )
 buffer.Append( point.x, point.y );
 } );
 
 font->Draw( &callback_gal, GetShownText(), GetTextPos(), GetAttributes() );
 
 buffer.Simplify( SHAPE_POLY_SET::PM_FAST );
 aBuffer.Append( buffer );
}

References SHAPE_POLY_SET::Append(), KIFONT::FONT::Draw(), ERROR_INSIDE, EDA_TEXT::GetAttributes(), EDA_TEXT::getDrawFont(), EDA_TEXT::GetEffectiveTextPenWidth(), GetShownText(), EDA_TEXT::GetTextPos(), SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::PM_FAST, SHAPE_POLY_SET::Simplify(), and TransformOvalToPolygon().

Referenced by GetEffectiveShape().

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

97{ return m_structType; }

EDA_ITEM::m_structType

KICAD_T m_structType

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

Definition: eda_item.h:505

References EDA_ITEM::m_structType.

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PCB_TEXT()

◆ ~PCB_TEXT()

Member Function Documentation

◆ AddRenderCacheGlyph()

◆ cacheShownText()

◆ ClassOf()

◆ ClearBoundingBoxCache()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearRenderCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ Compare()

◆ CopyText()

◆ DeleteStructure()

◆ Duplicate()

◆ Empty()

◆ Flip()

◆ Format()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetAttributes()

◆ GetBoard() [1/2]

◆ GetBoard() [2/2]

◆ GetBoundingBox()

◆ GetCenter()

◆ GetClass()

◆ getDrawFont()

◆ GetDrawPos()

◆ GetDrawRotation()

◆ GetEditFlags()

◆ GetEffectiveHoleShape()

◆ GetEffectiveShape()

◆ GetEffectiveTextPenWidth()

◆ GetEffectiveTextShape()

◆ GetFlags()

◆ GetFocusPosition()

◆ GetFont()

◆ GetFontName()

◆ GetFriendlyName()

◆ GetHorizJustify()

◆ GetHyperlink()

◆ GetInterline()

◆ GetItemDescription()

◆ getKnockoutMargin()

◆ GetLayer()

◆ GetLayerName()

◆ GetLayerSet()

◆ GetLinePositions()

◆ GetLineSpacing()

◆ GetMenuImage()

◆ GetMsgPanelInfo()

◆ GetParent()

◆ GetParentFootprint()

◆ GetParentGroup()

◆ GetPosition()

◆ GetRenderCache()

◆ GetShownText()

◆ GetSortPosition()

◆ GetState()

◆ GetStatus()

◆ GetStroke()

◆ GetText()

◆ GetTextAngle()

◆ GetTextAngleDegrees()

◆ GetTextBox()

◆ GetTextColor()