#include <lib_textbox.h>

Inheritance diagram for LIB_TEXTBOX:

Public Types
enum	LIB_CONVERT : int { BASE = 1 , DEMORGAN = 2 }

enum	COMPARE_FLAGS : int { UNIT = 0x01 , EQUALITY = 0x02 , ERC = 0x04 }
	The list of flags used by the compare function. More...

Public Member Functions
	LIB_TEXTBOX (LIB_SYMBOL *aParent, int aLineWidth=0, FILL_T aFillType=FILL_T::NO_FILL, const wxString &aText=wxEmptyString)

	LIB_TEXTBOX (const LIB_TEXTBOX &aText)

	~LIB_TEXTBOX ()

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

int	GetTextMargin () const

VECTOR2I	GetDrawPos () const override

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

void	MirrorHorizontally (const VECTOR2I &center)

void	MirrorVertically (const VECTOR2I &center)

void	Rotate (const VECTOR2I &aCenter, bool aRotateCCW) override
	Rotate the object about aCenter point. More...

bool	HitTest (const VECTOR2I &aPosition, int aAccuracy=0) 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...

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

bool	Replace (const EDA_SEARCH_DATA &aSearchData, void *aAuxData) override
	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
	Override this method in any derived object that supports test find and replace. More...

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

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

void	Plot (PLOTTER *aPlotter, bool aBackground, const VECTOR2I &offset, const TRANSFORM &aTransform, bool aDimmed) const override
	Plot the draw item using the plot object. More...

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

void	GetMsgPanelInfo (EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
	Display basic info (type, part and convert) about the current item in message panel. More...

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

wxString	GetTypeName () const override
	Provide a user-consumable name of the object type. More...

STROKE_PARAMS	GetStroke () const

void	SetStroke (const STROKE_PARAMS &aStroke)

int	GetPenWidth () const override

PLOT_DASH_TYPE	GetEffectiveLineStyle () const

const BOX2I	GetBoundingBox () const override

void	BeginEdit (const VECTOR2I &aStartPoint) override
	Begin drawing a symbol library draw item at aPosition. More...

bool	ContinueEdit (const VECTOR2I &aPosition) override
	Continue an edit in progress at aPosition. More...

void	CalcEdit (const VECTOR2I &aPosition) override
	Calculate the attributes of an item at aPosition when it is being edited. More...

void	EndEdit () override
	End an object editing action. More...

void	SetEditState (int aState)

void	AddPoint (const VECTOR2I &aPosition)

void	Offset (const VECTOR2I &aOffset) override
	Set the drawing object by aOffset from the current position. More...

void	MoveTo (const VECTOR2I &aPosition) override
	Move a draw object to aPosition. More...

VECTOR2I	GetPosition () const override

void	SetPosition (const VECTOR2I &aPosition) override

VECTOR2I	GetCenter () const

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

void	Normalize ()

void	MirrorHorizontal (const VECTOR2I &aCenter) override
	Mirror the draw object along the horizontal (X) axis about aCenter point. More...

void	MirrorVertical (const VECTOR2I &aCenter) override
	Mirror the draw object along the MirrorVertical (Y) axis about aCenter point. More...

virtual void	Print (const RENDER_SETTINGS aSettings, const VECTOR2I &aOffset, void aData, const TRANSFORM &aTransform, bool aDimmed)
	Draw an item. More...

const wxString &	GetDefaultFont () const

virtual int	GetEffectivePenWidth (const RENDER_SETTINGS *aSettings) const

LIB_SYMBOL *	GetParent () const

bool	operator== (const LIB_ITEM &aOther) const
	Test LIB_ITEM objects for equivalence. More...

bool	operator== (const LIB_ITEM *aOther) const

bool	operator< (const LIB_ITEM &aOther) const
	Test if another draw item is less than this draw object. More...

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

void	SetUnit (int aUnit)

int	GetUnit () const

void	SetConvert (int aConvert)

int	GetConvert () const

void	SetPrivate (bool aPrivate)

bool	IsPrivate () const

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

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

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

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

virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. 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

void	SwapShape (EDA_SHAPE *aImage)

wxString	ShowShape () const

wxString	SHAPE_T_asString () const

bool	IsAnnotationProxy () const

void	SetIsAnnotationProxy (bool aIsProxy=true)

bool	IsFilled () const

void	SetFilled (bool aFlag)

void	SetFillMode (FILL_T aFill)

FILL_T	GetFillMode () const

bool	IsClosed () const

COLOR4D	GetFillColor () const

void	SetFillColor (const COLOR4D &aColor)

void	SetWidth (int aWidth)

int	GetWidth () const

virtual int	GetEffectiveWidth () const

void	SetShape (SHAPE_T aShape)

SHAPE_T	GetShape () const

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

int	GetStartY () const

int	GetStartX () const

void	SetStart (const VECTOR2I &aStart)

void	SetStartY (int y)

void	SetStartX (int x)

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

int	GetEndY () const

int	GetEndX () const

void	SetEnd (const VECTOR2I &aEnd)

void	SetEndY (int y)

void	SetEndX (int x)

virtual VECTOR2I	GetTopLeft () const

virtual VECTOR2I	GetBotRight () const

virtual void	SetTop (int val)

virtual void	SetLeft (int val)

virtual void	SetRight (int val)

virtual void	SetBottom (int val)

void	SetBezierC1 (const VECTOR2I &aPt)

const VECTOR2I &	GetBezierC1 () const

void	SetBezierC2 (const VECTOR2I &aPt)

const VECTOR2I &	GetBezierC2 () const

VECTOR2I	getCenter () const

void	SetCenter (const VECTOR2I &aCenter)

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

EDA_ANGLE	GetArcAngle () const

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

VECTOR2I	GetArcMid () const

std::vector< VECTOR2I >	GetRectCorners () const

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

int	GetRadius () const

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

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

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

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

int	GetPointCount () const

SHAPE_POLY_SET &	GetPolyShape ()

const SHAPE_POLY_SET &	GetPolyShape () const

bool	IsPolyShapeValid () const

void	SetPolyShape (const SHAPE_POLY_SET &aShape)

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

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

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

double	GetLength () const
	Return the length of the track using the hypotenuse calculation. More...

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

int	Compare (const EDA_SHAPE *aOther) 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

virtual void	SetVisible (bool aVisible)

virtual bool	IsVisible () const

void	SetMirrored (bool isMirrored)

bool	IsMirrored () const

void	SetMultilineAllowed (bool aAllow)

bool	IsMultilineAllowed () const

void	SetHorizJustify (GR_TEXT_H_ALIGN_T aType)

GR_TEXT_H_ALIGN_T	GetHorizJustify () const

void	SetVertJustify (GR_TEXT_V_ALIGN_T aType)

GR_TEXT_V_ALIGN_T	GetVertJustify () const

void	SetKeepUpright (bool aKeepUpright)

bool	IsKeepUpright () const

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

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

virtual bool	TextHitTest (const BOX2I &aRect, bool aContains, int aAccuracy=0) const
	Test if object bounding box is contained within or intersects aRect. 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 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

Protected Member Functions
KIFONT::FONT *	getDrawFont () const override

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

void	setPosition (const VECTOR2I &aPos)

VECTOR2I	getPosition () const

void	move (const VECTOR2I &aMoveVector)

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

void	flip (const VECTOR2I &aCentre, bool aFlipLeftRight)

void	scale (double aScale)

const BOX2I	getBoundingBox () const

void	computeArcBBox (BOX2I &aBBox) const

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

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

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

void	beginEdit (const VECTOR2I &aStartPoint)

bool	continueEdit (const VECTOR2I &aPosition)

void	calcEdit (const VECTOR2I &aPosition)

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

void	setEditState (int aState)

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

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
int	m_unit
	Unit identification for multiple parts per package. More...

int	m_convert
	Shape identification for alternate body styles. More...

bool	m_private
	Private items are shown only in the Symbol Editor. More...

EDA_ITEM_FLAGS	m_status

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

bool	m_forceVisible

EDA_ITEM_FLAGS	m_flags

bool	m_endsSwapped

SHAPE_T	m_shape

STROKE_PARAMS	m_stroke

FILL_T	m_fill

COLOR4D	m_fillColor

VECTOR2I	m_start

VECTOR2I	m_end

VECTOR2I	m_arcCenter

ARC_MID	m_arcMidData

VECTOR2I	m_bezierC1

VECTOR2I	m_bezierC2

std::vector< VECTOR2I >	m_bezierPoints

SHAPE_POLY_SET	m_poly

int	m_editState

bool	m_annotationProxy

wxString	m_hyperlink
	A hyperlink URL. More...

Private Member Functions
int	compare (const LIB_ITEM &aOther, int aCompareFlags=0) const override
	Provide the draw object specific comparison called by the == and < operators. More...

void	print (const RENDER_SETTINGS aSettings, const VECTOR2I &aOffset, void aData, const TRANSFORM &aTransform, bool aDimmed) override
	Print the item to aDC. More...

EDA_ANGLE	getParentOrientation () const override

VECTOR2I	getParentPosition () const override

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 34 of file lib_textbox.h.

Member Enumeration Documentation

◆ COMPARE_FLAGS

enum LIB_ITEM::COMPARE_FLAGS : int

inherited

The list of flags used by the compare function.

UNIT This flag relaxes unit, conversion and pin number constraints. It is used for LIB_ITEM object unit comparisons.
EQUALITY This flag relaxes ordering contstraints so that fields, etc. don't have to appear in the same order to be considered equal.
ERC This flag relaxes constraints on data that is settable in the schematic editor. It compares only symbol-editor-only data.

Enumerator
UNIT
EQUALITY
ERC

Definition at line 82 of file lib_item.h.

 {
 UNIT = 0x01,
 EQUALITY = 0x02,
 ERC = 0x04
 };

◆ LIB_CONVERT

enum LIB_ITEM::LIB_CONVERT : int

inherited

Enumerator
BASE
DEMORGAN

Definition at line 70 of file lib_item.h.

70: int { BASE = 1, DEMORGAN = 2 };

LIB_ITEM::BASE

@ BASE

Definition: lib_item.h:70

LIB_ITEM::DEMORGAN

@ DEMORGAN

Definition: lib_item.h:70

Constructor & Destructor Documentation

◆ LIB_TEXTBOX() [1/2]

LIB_TEXTBOX::LIB_TEXTBOX	(	LIB_SYMBOL *	aParent,
		int	aLineWidth = `0`,
		FILL_T	aFillType = `FILL_T::NO_FILL`,
		const wxString &	aText = `wxEmptyString`
	)

Definition at line 45 of file lib_textbox.cpp.

 :
 LIB_SHAPE( aParent, SHAPE_T::RECT, aLineWidth, aFillType, LIB_TEXTBOX_T ),
 EDA_TEXT( schIUScale, text )
{
 SetTextSize( VECTOR2I( schIUScale.MilsToIU( DEFAULT_TEXT_SIZE ),
 schIUScale.MilsToIU( DEFAULT_TEXT_SIZE ) ) );
 SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
 SetVertJustify( GR_TEXT_V_ALIGN_TOP );
 SetMultilineAllowed( true );
}

References DEFAULT_TEXT_SIZE, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_TOP, EDA_IU_SCALE::MilsToIU(), RECT, schIUScale, EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetMultilineAllowed(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetVertJustify(), and text.

Referenced by Clone().

◆ LIB_TEXTBOX() [2/2]

LIB_TEXTBOX::LIB_TEXTBOX ( const LIB_TEXTBOX & aText )

Definition at line 58 of file lib_textbox.cpp.

 :
 LIB_SHAPE( aText ),
 EDA_TEXT( aText )
{ }

◆ ~LIB_TEXTBOX()

LIB_TEXTBOX::~LIB_TEXTBOX ( )

inline

Definition at line 42 of file lib_textbox.h.

42{ }

Member Function Documentation

◆ AddPoint()

void LIB_SHAPE::AddPoint ( const VECTOR2I & aPosition )

inherited

Definition at line 518 of file lib_shape.cpp.

{
 if( GetShape() == SHAPE_T::POLY )
 {
 if( m_poly.IsEmpty() )
 m_poly.NewOutline();
 
 m_poly.Outline( 0 ).Append( aPosition, true );
 }
 else
 {
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References SHAPE_LINE_CHAIN::Append(), EDA_SHAPE::GetShape(), SHAPE_POLY_SET::IsEmpty(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), POLY, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), HelperGeneratePowerPortGraphics(), SCH_EAGLE_PLUGIN::loadFrame(), CADSTAR_SCH_ARCHIVE_LOADER::loadLibrarySymbolShapeVertices(), SCH_LEGACY_PLUGIN_CACHE::loadPolyLine(), SCH_EAGLE_PLUGIN::loadSymbolPolyLine(), SCH_EAGLE_PLUGIN::loadSymbolWire(), SCH_ALTIUM_PLUGIN::ParseBezier(), SCH_ALTIUM_PLUGIN::ParseLine(), SCH_ALTIUM_PLUGIN::ParsePolygon(), and SCH_ALTIUM_PLUGIN::ParsePolyline().

◆ AddRenderCacheGlyph()

void EDA_TEXT::AddRenderCacheGlyph ( const SHAPE_POLY_SET & aPoly )

inherited

Definition at line 493 of file eda_text.cpp.

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

References EDA_TEXT::m_render_cache.

◆ beginEdit()

void EDA_SHAPE::beginEdit ( const VECTOR2I & aStartPoint )

protectedinherited

Definition at line 1265 of file eda_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 SetStart( aPosition );
 SetEnd( aPosition );
 break;
 
 case SHAPE_T::ARC:
 SetArcGeometry( aPosition, aPosition, aPosition );
 m_editState = 1;
 break;
 
 case SHAPE_T::POLY:
 m_poly.NewOutline();
 m_poly.Outline( 0 ).SetClosed( false );
 
 // Start and end of the first segment (co-located for now)
 m_poly.Outline( 0 ).Append( aPosition );
 m_poly.Outline( 0 ).Append( aPosition, true );
 break;
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References SHAPE_LINE_CHAIN::Append(), ARC, CIRCLE, EDA_SHAPE::GetShape(), EDA_SHAPE::m_editState, EDA_SHAPE::m_poly, SHAPE_POLY_SET::NewOutline(), SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SetArcGeometry(), SHAPE_LINE_CHAIN::SetClosed(), EDA_SHAPE::SetEnd(), EDA_SHAPE::SetStart(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by SCH_SHAPE::BeginEdit(), and LIB_SHAPE::BeginEdit().

◆ BeginEdit()

void LIB_SHAPE::BeginEdit ( const VECTOR2I & aPosition )

inlineoverridevirtualinherited

Begin drawing a symbol library draw item at aPosition.

It typically would be called on a left click when a draw tool is selected in the symbol library editor and one of the graphics tools is selected.

Parameters

aPosition The position in drawing coordinates where the drawing was started. May or may not be required depending on the item being drawn.

Reimplemented from LIB_ITEM.

Definition at line 72 of file lib_shape.h.

72{ beginEdit( aStartPoint ); }

EDA_SHAPE::beginEdit

void beginEdit(const VECTOR2I &aStartPoint)

Definition: eda_shape.cpp:1265

References EDA_SHAPE::beginEdit().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

◆ buildBezierToSegmentsPointsList()

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

protectedinherited

Definition at line 431 of file eda_shape.cpp.

{
 std::vector<VECTOR2I> bezierPoints;
 
 // Rebuild the m_BezierPoints vertex list that approximate the Bezier curve
 std::vector<VECTOR2I> ctrlPoints = { m_start, m_bezierC1, m_bezierC2, m_end };
 BEZIER_POLY converter( ctrlPoints );
 converter.GetPoly( bezierPoints, aMinSegLen );
 
 return bezierPoints;
}

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

Referenced by EDA_SHAPE::makeEffectiveShapes(), and EDA_SHAPE::RebuildBezierToSegmentsPointsList().

◆ cacheShownText()

void EDA_TEXT::cacheShownText ( )

protectedinherited

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

◆ CalcArcAngles()

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

inherited

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

Each may be between -360.0 and 360.0.

Definition at line 502 of file eda_shape.cpp.

{
 VECTOR2D startRadial( GetStart() - getCenter() );
 VECTOR2D endRadial( GetEnd() - getCenter() );
 
 aStartAngle = EDA_ANGLE( startRadial );
 aEndAngle = EDA_ANGLE( endRadial );
 
 if( aEndAngle == aStartAngle )
 aEndAngle = aStartAngle + ANGLE_360; // ring, not null
 
 if( aStartAngle > aEndAngle )
 {
 if( aEndAngle < ANGLE_0 )
 aEndAngle.Normalize();
 else
 aStartAngle = aStartAngle.Normalize() - ANGLE_360;
 }
}

References ANGLE_0, ANGLE_360, EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetStart(), and EDA_ANGLE::Normalize().

Referenced by EDA_SHAPE::computeArcBBox(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), EDA_SHAPE::GetArcAngle(), EDA_SHAPE::hitTest(), LIB_SHAPE::Plot(), LIB_SHAPE::print(), and SCH_LEGACY_PLUGIN_CACHE::saveArc().

◆ calcEdit()

void EDA_SHAPE::calcEdit ( const VECTOR2I & aPosition )

protectedinherited

Definition at line 1323 of file eda_shape.cpp.

{
#define sq( x ) pow( x, 2 )
 
 switch( GetShape() )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 SetEnd( aPosition );
 break;
 
 case SHAPE_T::ARC:
 {
 int radius = GetRadius();
 
 // Edit state 0: drawing: place start
 // Edit state 1: drawing: place end (center calculated for 90-degree subtended angle)
 // Edit state 2: point edit: move start (center calculated for invariant subtended angle)
 // Edit state 3: point edit: move end (center calculated for invariant subtended angle)
 // Edit state 4: point edit: move center
 // Edit state 5: point edit: move arc-mid-point
 
 switch( m_editState )
 {
 case 0:
 SetArcGeometry( aPosition, aPosition, aPosition );
 return;
 
 case 1:
 m_end = aPosition;
 radius = KiROUND( sqrt( sq( GetLineLength( m_start, m_end ) ) / 2.0 ) );
 break;
 
 case 2:
 case 3:
 {
 VECTOR2I v = m_start - m_end;
 double chordBefore = sq( v.x ) + sq( v.y );
 
 if( m_editState == 2 )
 m_start = aPosition;
 else
 m_end = aPosition;
 
 v = m_start - m_end;
 double chordAfter = sq( v.x ) + sq( v.y );
 double ratio = chordAfter / chordBefore;
 
 if( ratio != 0 )
 {
 radius = std::max( int( sqrt( sq( radius ) * ratio ) ) + 1,
 int( sqrt( chordAfter ) / 2 ) + 1 );
 }
 }
 break;
 
 case 4:
 {
 double radialA = GetLineLength( m_start, aPosition );
 double radialB = GetLineLength( m_end, aPosition );
 radius = int( ( radialA + radialB ) / 2.0 ) + 1;
 }
 break;
 
 case 5:
 SetArcGeometry( GetStart(), aPosition, GetEnd() );
 return;
 }
 
 // Calculate center based on start, end, and radius
 //
 // Let 'l' be the length of the chord and 'm' the middle point of the chord
 double l = GetLineLength( m_start, m_end );
 VECTOR2I m = ( m_start + m_end ) / 2;
 
 // Calculate 'd', the vector from the chord midpoint to the center
 VECTOR2I d;
 d.x = KiROUND( sqrt( sq( radius ) - sq( l/2 ) ) * ( m_start.y - m_end.y ) / l );
 d.y = KiROUND( sqrt( sq( radius ) - sq( l/2 ) ) * ( m_end.x - m_start.x ) / l );
 
 VECTOR2I c1 = m + d;
 VECTOR2I c2 = m - d;
 
 // Solution gives us 2 centers; we need to pick one:
 switch( m_editState )
 {
 case 1:
 // Keep arc clockwise while drawing i.e. arc angle = 90 deg.
 // it can be 90 or 270 deg depending on the arc center choice (c1 or c2)
 m_arcCenter = c1; // first trial
 
 if( GetArcAngle() > ANGLE_180 )
 m_arcCenter = c2;
 
 break;
 
 case 2:
 case 3:
 // Pick the one of c1, c2 to keep arc <= 180 deg
 m_arcCenter = c1; // first trial
 
 if( GetArcAngle() > ANGLE_180 )
 m_arcCenter = c2;
 
 break;
 
 case 4:
 // Pick the one closer to the mouse position
 m_arcCenter = GetLineLength( c1, aPosition ) < GetLineLength( c2, aPosition ) ? c1 : c2;
 
 // keep arc angle <= 180 deg
 if( GetArcAngle() > ANGLE_180 )
 std::swap( m_start, m_end );
 
 break;
 }
 }
 break;
 
 case SHAPE_T::POLY:
 m_poly.Outline( 0 ).SetPoint( m_poly.Outline( 0 ).GetPointCount() - 1, aPosition );
 break;
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References ANGLE_180, ARC, CIRCLE, EDA_SHAPE::GetArcAngle(), EDA_SHAPE::GetEnd(), GetLineLength(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetShape(), EDA_SHAPE::GetStart(), KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_editState, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_start, SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SetArcGeometry(), EDA_SHAPE::SetEnd(), SHAPE_LINE_CHAIN::SetPoint(), EDA_SHAPE::SHAPE_T_asString(), sq, UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ CalcEdit()

void LIB_SHAPE::CalcEdit ( const VECTOR2I & aPosition )

inlineoverridevirtualinherited

Calculate the attributes of an item at aPosition when it is being edited.

This method gets called by the Draw() method when the item is being edited. This probably should be a pure virtual method but bezier curves are not yet editable in the symbol library editor. Therefore, the default method does nothing.

Parameters

aPosition The current mouse position in drawing coordinates.

Reimplemented from LIB_ITEM.

Definition at line 74 of file lib_shape.h.

74{ calcEdit( aPosition ); }

EDA_SHAPE::calcEdit

void calcEdit(const VECTOR2I &aPosition)

Definition: eda_shape.cpp:1323

References EDA_SHAPE::calcEdit().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), and EE_POINT_EDITOR::updateParentItem().

◆ ClassOf()

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

inlinestatic

Definition at line 44 of file lib_textbox.h.

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

References LIB_TEXTBOX_T, and EDA_ITEM::Type().

◆ ClearBoundingBoxCache()

void EDA_TEXT::ClearBoundingBoxCache ( )

virtualinherited

Definition at line 446 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(), SCH_EDIT_FRAME::RecomputeIntersheetRefs(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ 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(), BOARD_COMMIT::dirtyIntersectingZones(), 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

Reimplemented in SCH_FIELD, and PCB_DIMENSION_BASE.

Definition at line 440 of file eda_text.cpp.

{
 m_render_cache.clear();
}

References EDA_TEXT::m_render_cache.

Referenced by EDA_TEXT::cacheShownText(), SCH_FIELD::ClearRenderCache(), PCB_DIMENSION_BASE::ClearRenderCache(), EDA_TEXT::CopyText(), EDA_TEXT::Empty(), EDA_TEXT::Replace(), EDA_TEXT::SetAttributes(), EDA_TEXT::SetBold(), EDA_TEXT::SetFont(), EDA_TEXT::SetHorizJustify(), EDA_TEXT::SetItalic(), EDA_TEXT::SetKeepUpright(), EDA_TEXT::SetLineSpacing(), EDA_TEXT::SetMirrored(), EDA_TEXT::SetMultilineAllowed(), EDA_TEXT::SetText(), EDA_TEXT::SetTextAngle(), EDA_TEXT::SetTextHeight(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), EDA_TEXT::SetTextWidth(), EDA_TEXT::SetVertJustify(), EDA_TEXT::SetVisible(), EDA_TEXT::SwapAttributes(), EDA_TEXT::SwapText(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and EE_POINT_EDITOR::updateParentItem().

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

inlineoverridevirtual

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

Definition at line 87 of file lib_textbox.h.

 {
 return new LIB_TEXTBOX( *this );
 }

References LIB_TEXTBOX().

◆ Compare() [1/2]

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

inherited

Definition at line 1508 of file eda_shape.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_start, aOther->m_start );
 TEST_PT( m_end, aOther->m_end );
 
 TEST( (int) m_shape, (int) aOther->m_shape );
 
 if( m_shape == SHAPE_T::ARC )
 {
 TEST_PT( m_arcCenter, aOther->m_arcCenter );
 }
 else if( m_shape == SHAPE_T::BEZIER )
 {
 TEST_PT( m_bezierC1, aOther->m_bezierC1 );
 TEST_PT( m_bezierC2, aOther->m_bezierC2 );
 }
 else if( m_shape == SHAPE_T::POLY )
 {
 TEST( m_poly.TotalVertices(), aOther->m_poly.TotalVertices() );
 }
 
 for( size_t ii = 0; ii < m_bezierPoints.size(); ++ii )
 TEST_PT( m_bezierPoints[ii], aOther->m_bezierPoints[ii] );
 
 for( int ii = 0; ii < m_poly.TotalVertices(); ++ii )
 TEST_PT( m_poly.CVertex( ii ), aOther->m_poly.CVertex( ii ) );
 
 TEST_E( m_stroke.GetWidth(), aOther->m_stroke.GetWidth() );
 TEST( (int) m_stroke.GetPlotStyle(), (int) aOther->m_stroke.GetPlotStyle() );
 TEST( (int) m_fill, (int) aOther->m_fill );
 
 return 0;
}

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

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

◆ Compare() [2/2]

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

inherited

Definition at line 913 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 );
}

◆ compare()

int LIB_TEXTBOX::compare	(	const LIB_ITEM &	aOther,
		int	aCompareFlags = `0`
	)		const

overrideprivatevirtual

Provide the draw object specific comparison called by the == and < operators.

The base object sort order which always proceeds the derived object sort order is as follows:

Symbol alternate part (DeMorgan) number.
Symbol part number.
KICAD_T enum value.
Result of derived classes comparison.

Note: Make sure you call down to LIB_ITEM::compare before doing any derived object comparisons or you will break the sorting using the symbol library file format.

Parameters

aOther	A reference to the other LIB_ITEM to compare the arc against.
aCompareFlags	The flags used to perform the comparison.

Returns: An integer value less than 0 if the object is less than aOther object, zero if the object is equal to aOther object, or greater than 0 if the object is greater than aOther object.

The circle specific sort order is as follows:

Circle horizontal (X) position.
Circle vertical (Y) position.
Circle radius.

Reimplemented from LIB_SHAPE.

Definition at line 176 of file lib_textbox.cpp.

{
 wxASSERT( aOther.Type() == LIB_TEXTBOX_T );
 
 int retv = LIB_ITEM::compare( aOther, aCompareFlags );
 
 if( retv )
 return retv;
 
 const LIB_TEXTBOX* tmp = static_cast<const LIB_TEXTBOX*>( &aOther );
 
 int result = GetText().CmpNoCase( tmp->GetText() );
 
 if( result != 0 )
 return result;
 
 if( GetTextWidth() != tmp->GetTextWidth() )
 return GetTextWidth() - tmp->GetTextWidth();
 
 if( GetTextHeight() != tmp->GetTextHeight() )
 return GetTextHeight() - tmp->GetTextHeight();
 
 if( IsBold() != tmp->IsBold() )
 return IsBold() - tmp->IsBold();
 
 if( IsItalic() != tmp->IsItalic() )
 return IsItalic() - tmp->IsItalic();
 
 if( GetHorizJustify() != tmp->GetHorizJustify() )
 return GetHorizJustify() - tmp->GetHorizJustify();
 
 if( GetTextAngle().AsTenthsOfADegree() != tmp->GetTextAngle().AsTenthsOfADegree() )
 return GetTextAngle().AsTenthsOfADegree() - tmp->GetTextAngle().AsTenthsOfADegree();
 
 return EDA_SHAPE::Compare( &static_cast<const LIB_SHAPE&>( aOther ) );
}

References EDA_ANGLE::AsTenthsOfADegree(), EDA_SHAPE::Compare(), LIB_ITEM::compare(), EDA_TEXT::GetHorizJustify(), EDA_TEXT::GetText(), EDA_TEXT::GetTextAngle(), EDA_TEXT::GetTextHeight(), EDA_TEXT::GetTextWidth(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), LIB_TEXTBOX_T, and EDA_ITEM::Type().

◆ computeArcBBox()

void EDA_SHAPE::computeArcBBox ( BOX2I & aBBox ) const

protectedinherited

Definition at line 1071 of file eda_shape.cpp.

{
 // Start, end, and each inflection point the arc crosses will enclose the entire arc.
 // Only include the center when filled; it's not necessarily inside the BB of an unfilled
 // arc with a small included angle.
 aBBox.SetOrigin( m_start );
 aBBox.Merge( m_end );
 
 if( IsFilled() )
 aBBox.Merge( m_arcCenter );
 
 int radius = GetRadius();
 EDA_ANGLE t1, t2;
 
 CalcArcAngles( t1, t2 );
 
 t1.Normalize();
 t2.Normalize();
 
 if( t2 > t1 )
 {
 if( t1 < ANGLE_0 && t2 > ANGLE_0 )
 aBBox.Merge( VECTOR2I( m_arcCenter.x + radius, m_arcCenter.y ) ); // right
 
 if( t1 < ANGLE_90 && t2 > ANGLE_90 )
 aBBox.Merge( VECTOR2I( m_arcCenter.x, m_arcCenter.y + radius ) ); // down
 
 if( t1 < ANGLE_180 && t2 > ANGLE_180 )
 aBBox.Merge( VECTOR2I( m_arcCenter.x - radius, m_arcCenter.y ) ); // left
 
 if( t1 < ANGLE_270 && t2 > ANGLE_270 )
 aBBox.Merge( VECTOR2I( m_arcCenter.x, m_arcCenter.y - radius ) ); // up
 }
 else
 {
 if( t1 < ANGLE_0 || t2 > ANGLE_0 )
 aBBox.Merge( VECTOR2I( m_arcCenter.x + radius, m_arcCenter.y ) ); // right
 
 if( t1 < ANGLE_90 || t2 > ANGLE_90 )
 aBBox.Merge( VECTOR2I( m_arcCenter.x, m_arcCenter.y + radius ) ); // down
 
 if( t1 < ANGLE_180 || t2 > ANGLE_180 )
 aBBox.Merge( VECTOR2I( m_arcCenter.x - radius, m_arcCenter.y ) ); // left
 
 if( t1 < ANGLE_270 || t2 > ANGLE_270 )
 aBBox.Merge( VECTOR2I( m_arcCenter.x, m_arcCenter.y - radius ) ); // up
 }
}

References ANGLE_0, ANGLE_180, ANGLE_270, ANGLE_90, EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::GetRadius(), EDA_SHAPE::IsFilled(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_start, BOX2< Vec >::Merge(), EDA_ANGLE::Normalize(), BOX2< Vec >::SetOrigin(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by EDA_SHAPE::getBoundingBox().

◆ continueEdit()

bool EDA_SHAPE::continueEdit ( const VECTOR2I & aPosition )

protectedinherited

Definition at line 1296 of file eda_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 return false;
 
 case SHAPE_T::POLY:
 {
 SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );
 
 // do not add zero-length segments
 if( poly.CPoint( poly.GetPointCount() - 2 ) != poly.CLastPoint() )
 poly.Append( aPosition, true );
 }
 return true;
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References SHAPE_LINE_CHAIN::Append(), ARC, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

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

◆ ContinueEdit()

bool LIB_SHAPE::ContinueEdit ( const VECTOR2I & aPosition )

inlineoverridevirtualinherited

Continue an edit in progress at aPosition.

This is used to perform the next action while drawing an item. This would be called for each additional left click when the mouse is captured while the item is being drawn.

Parameters

aPosition The position of the mouse left click in drawing coordinates.

Returns: True if additional mouse clicks are required to complete the edit in progress.

Reimplemented from LIB_ITEM.

Definition at line 73 of file lib_shape.h.

73{ return continueEdit( aPosition ); }

EDA_SHAPE::continueEdit

bool continueEdit(const VECTOR2I &aPosition)

Definition: eda_shape.cpp:1296

References EDA_SHAPE::continueEdit().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

◆ CopyText()

void EDA_TEXT::CopyText ( const EDA_TEXT & aSrc )

inherited

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

◆ DupPolyPointsList()

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

inherited

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

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

Definition at line 1225 of file eda_shape.cpp.

{
 for( int ii = 0; ii < m_poly.OutlineCount(); ++ii )
 {
 int pointCount = m_poly.COutline( ii ).PointCount();
 
 if( pointCount )
 {
 aBuffer.reserve( pointCount );
 
 for ( auto iter = m_poly.CIterate(); iter; iter++ )
 aBuffer.emplace_back( iter->x, iter->y );
 }
 }
}

References SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::COutline(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::OutlineCount(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by BRDITEMS_PLOTTER::PlotFootprintShape(), EDA_SHAPE::TransformShapeToPolygon(), FP_TEXTBOX::TransformShapeToPolygon(), and PCB_POINT_EDITOR::updatePoints().

◆ Empty()

void EDA_TEXT::Empty ( )

inherited

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

◆ EndEdit()

void LIB_SHAPE::EndEdit ( )

inlineoverridevirtualinherited

End an object editing action.

This is used to end or abort an edit action in progress initiated by BeginEdit().

Reimplemented from LIB_ITEM.

Definition at line 76 of file lib_shape.h.

76{ endEdit( false ); }

EDA_SHAPE::endEdit

void endEdit(bool aClosed=true)

Finishes editing the shape.

Definition: eda_shape.cpp:1453

References EDA_SHAPE::endEdit().

Referenced by SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape().

◆ endEdit()

void EDA_SHAPE::endEdit ( bool aClosed = true )

protectedinherited

Finishes editing the shape.

Parameters

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

Definition at line 1453 of file eda_shape.cpp.

{
 switch( GetShape() )
 {
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 break;
 
 case SHAPE_T::POLY:
 {
 SHAPE_LINE_CHAIN& poly = m_poly.Outline( 0 );
 
 // do not include last point twice
 if( poly.GetPointCount() > 2 )
 {
 if( poly.CPoint( poly.GetPointCount() - 2 ) == poly.CLastPoint() )
 {
 poly.SetClosed( aClosed );
 poly.Remove( poly.GetPointCount() - 1 );
 }
 }
 }
 break;
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
}

References ARC, CIRCLE, SHAPE_LINE_CHAIN::CLastPoint(), SHAPE_LINE_CHAIN::CPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetShape(), EDA_SHAPE::m_poly, SHAPE_POLY_SET::Outline(), POLY, RECT, SHAPE_LINE_CHAIN::Remove(), SEGMENT, SHAPE_LINE_CHAIN::SetClosed(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by SCH_SHAPE::EndEdit(), and LIB_SHAPE::EndEdit().

◆ EndsSwapped()

bool EDA_SHAPE::EndsSwapped ( ) const

inlineinherited

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

Returns: true if they have

Definition at line 195 of file eda_shape.h.

195{ return m_endsSwapped; }

EDA_SHAPE::m_endsSwapped

bool m_endsSwapped

Definition: eda_shape.h:363

References EDA_SHAPE::m_endsSwapped.

Referenced by BOOST_AUTO_TEST_CASE(), and CADSTAR_PCB_ARCHIVE_LOADER::makeTracksFromShapes().

◆ flip()

void EDA_SHAPE::flip	(	const VECTOR2I &	aCentre,
		bool	aFlipLeftRight
	)

protectedinherited

Definition at line 320 of file eda_shape.cpp.

{
 switch ( m_shape )
 {
 case SHAPE_T::SEGMENT:
 case SHAPE_T::RECT:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 }
 
 std::swap( m_start, m_end );
 break;
 
 case SHAPE_T::CIRCLE:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 }
 break;
 
 case SHAPE_T::ARC:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 m_arcCenter.x = aCentre.x - ( m_arcCenter.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 m_arcCenter.y = aCentre.y - ( m_arcCenter.y - aCentre.y );
 }
 
 std::swap( m_start, m_end );
 break;
 
 case SHAPE_T::POLY:
 m_poly.Mirror( aFlipLeftRight, !aFlipLeftRight, aCentre );
 break;
 
 case SHAPE_T::BEZIER:
 if( aFlipLeftRight )
 {
 m_start.x = aCentre.x - ( m_start.x - aCentre.x );
 m_end.x = aCentre.x - ( m_end.x - aCentre.x );
 m_bezierC1.x = aCentre.x - ( m_bezierC1.x - aCentre.x );
 m_bezierC2.x = aCentre.x - ( m_bezierC2.x - aCentre.x );
 }
 else
 {
 m_start.y = aCentre.y - ( m_start.y - aCentre.y );
 m_end.y = aCentre.y - ( m_end.y - aCentre.y );
 m_bezierC1.y = aCentre.y - ( m_bezierC1.y - aCentre.y );
 m_bezierC2.y = aCentre.y - ( m_bezierC2.y - aCentre.y );
 }
 
 // Rebuild the poly points shape
 {
 std::vector<VECTOR2I> ctrlPoints = { m_start, m_bezierC1, m_bezierC2, m_end };
 BEZIER_POLY converter( ctrlPoints );
 converter.GetPoly( m_bezierPoints, m_stroke.GetWidth() );
 }
 break;
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
}

References ARC, BEZIER, CIRCLE, BEZIER_POLY::GetPoly(), STROKE_PARAMS::GetWidth(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_bezierC1, EDA_SHAPE::m_bezierC2, EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::m_stroke, SHAPE_POLY_SET::Mirror(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_SHAPE::Flip(), LIB_SHAPE::MirrorHorizontal(), SCH_SHAPE::MirrorHorizontally(), LIB_SHAPE::MirrorVertical(), and SCH_SHAPE::MirrorVertically().

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

◆ GetArcAngle()

EDA_ANGLE EDA_SHAPE::GetArcAngle ( ) const

inherited

Definition at line 585 of file eda_shape.cpp.

{
 EDA_ANGLE startAngle;
 EDA_ANGLE endAngle;
 
 CalcArcAngles( startAngle, endAngle );
 
 return endAngle - startAngle;
}

References EDA_SHAPE::CalcArcAngles().

Referenced by BOARD_ADAPTER::addShape(), EDA_SHAPE::calcEdit(), ALTIUM_PCB::ConvertArcs6ToBoardItemOnLayer(), ConvertOutlineToPolygon(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), FootprintWriteShape(), EDA_SHAPE::GetArcMid(), FP_SHAPE::GetArcMid0(), EDA_SHAPE::GetLength(), CADSTAR_PCB_ARCHIVE_LOADER::getLineChainFromShapes(), idf_export_outline(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), EDA_SHAPE::makeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), EDA_SHAPE::ShapeGetMsgPanelInfo(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), and DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow().

◆ GetArcMid()

VECTOR2I EDA_SHAPE::GetArcMid ( ) const

inherited

Definition at line 488 of file eda_shape.cpp.

{
 // If none of the input data have changed since we loaded the arc,
 // keep the original mid point data to minimize churn
 if( m_arcMidData.start == m_start && m_arcMidData.end == m_end
 && m_arcMidData.center == m_arcCenter )
 return m_arcMidData.mid;
 
 VECTOR2I mid = m_start;
 RotatePoint( mid, m_arcCenter, -GetArcAngle() / 2.0 );
 return mid;
}

References ARC_MID::center, ARC_MID::end, EDA_SHAPE::GetArcAngle(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_arcMidData, EDA_SHAPE::m_end, EDA_SHAPE::m_start, ARC_MID::mid, RotatePoint(), and ARC_MID::start.

Referenced by KI_TEST::CheckFpShape(), PCB_POINT_EDITOR::editArcMidKeepEndpoints(), PCB_PLUGIN::format(), formatArc(), PCB_SHAPE::GetFocusPosition(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromChainedSegs(), EDA_SHAPE::SetArcGeometry(), EDA_SHAPE::TransformShapeToPolygon(), and PCB_POINT_EDITOR::updatePoints().

◆ GetAttributes()

const TEXT_ATTRIBUTES & EDA_TEXT::GetAttributes ( ) const

inlineinherited

◆ GetBezierC1()

const VECTOR2I & EDA_SHAPE::GetBezierC1 ( ) const

inlineinherited

◆ GetBezierC2()

const VECTOR2I & EDA_SHAPE::GetBezierC2 ( ) const

inlineinherited

◆ GetBezierPoints()

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

inlineinherited

Definition at line 230 of file eda_shape.h.

230{ return m_bezierPoints; }

References EDA_SHAPE::m_bezierPoints.

Referenced by ConvertOutlineToPolygon(), GRAPHICS_CLEANER::isNullShape(), and CONVERT_TOOL::makePolysFromChainedSegs().

◆ GetBotRight()

virtual VECTOR2I EDA_SHAPE::GetBotRight ( ) const

inlinevirtualinherited

Reimplemented in FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 168 of file eda_shape.h.

168{ return GetEnd(); }

References EDA_SHAPE::GetEnd().

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::makePoints(), and PCB_POINT_EDITOR::updatePoints().

◆ getBoundingBox()

const BOX2I EDA_SHAPE::getBoundingBox ( ) const

protectedinherited

Definition at line 684 of file eda_shape.cpp.

{
 BOX2I bbox;
 
 switch( m_shape )
 {
 case SHAPE_T::RECT:
 for( VECTOR2I& pt : GetRectCorners() )
 bbox.Merge( pt );
 
 break;
 
 case SHAPE_T::SEGMENT:
 bbox.SetOrigin( GetStart() );
 bbox.SetEnd( GetEnd() );
 break;
 
 case SHAPE_T::CIRCLE:
 bbox.SetOrigin( GetStart() );
 bbox.Inflate( GetRadius() );
 break;
 
 case SHAPE_T::ARC:
 computeArcBBox( bbox );
 break;
 
 case SHAPE_T::POLY:
 if( m_poly.IsEmpty() )
 break;
 
 for( auto iter = m_poly.CIterate(); iter; iter++ )
 {
 VECTOR2I pt( iter->x, iter->y );
 
 RotatePoint( pt, getParentOrientation() );
 pt += getParentPosition();
 
 bbox.Merge( pt );
 }
 
 break;
 
 case SHAPE_T::BEZIER:
 bbox.SetOrigin( GetStart() );
  bbox.Merge( GetBezierC1() );
 bbox.Merge( GetBezierC2() );
 bbox.Merge( GetEnd() );
 break;
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 break;
 }
 
 bbox.Inflate( std::max( 0, GetWidth() ) / 2 );
 bbox.Normalize();
 
 return bbox;
}

References ARC, BEZIER, CIRCLE, SHAPE_POLY_SET::CIterate(), EDA_SHAPE::computeArcBBox(), EDA_SHAPE::GetBezierC1(), EDA_SHAPE::GetBezierC2(), EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetWidth(), BOX2< Vec >::Inflate(), SHAPE_POLY_SET::IsEmpty(), EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, BOX2< Vec >::Merge(), BOX2< Vec >::Normalize(), POLY, RECT, RotatePoint(), SEGMENT, BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

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

◆ GetBoundingBox()

const BOX2I LIB_SHAPE::GetBoundingBox ( ) const

overridevirtualinherited

Returns: the boundary box for this, in library coordinates

Reimplemented from LIB_ITEM.

Definition at line 451 of file lib_shape.cpp.

{
 BOX2I bbox = getBoundingBox();
 
 bbox.RevertYAxis();
 
 return bbox;
}

References EDA_SHAPE::getBoundingBox(), and BOX2< Vec >::RevertYAxis().

Referenced by HitTest().

◆ GetCenter()

VECTOR2I LIB_SHAPE::GetCenter ( ) const

inlineinherited

Definition at line 88 of file lib_shape.h.

88{ return getCenter(); }

References EDA_SHAPE::getCenter().

Referenced by SCH_EAGLE_PLUGIN::loadSymbolRectangle(), and SCH_ALTIUM_PLUGIN::ParseArc().

◆ getCenter()

VECTOR2I EDA_SHAPE::getCenter ( ) const

inherited

Definition at line 444 of file eda_shape.cpp.

{
 switch( m_shape )
 {
 case SHAPE_T::ARC:
 return m_arcCenter;
 
 case SHAPE_T::CIRCLE:
 return m_start;
 
 case SHAPE_T::SEGMENT:
 // Midpoint of the line
 return ( m_start + m_end ) / 2;
 
 case SHAPE_T::POLY:
 case SHAPE_T::RECT:
 case SHAPE_T::BEZIER:
 return getBoundingBox().Centre();
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return VECTOR2I();
 }
}

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

Referenced by EDA_SHAPE::CalcArcAngles(), LIB_SHAPE::GetCenter(), SCH_SHAPE::GetCenter(), PCB_SHAPE::GetCenter(), EDA_SHAPE::getPosition(), EDA_SHAPE::hitTest(), EDA_SHAPE::makeEffectiveShapes(), SCH_SHAPE::Plot(), LIB_SHAPE::Plot(), SCH_SHAPE::Print(), LIB_SHAPE::print(), SCH_SHAPE::PrintBackground(), PLOTTER::ThickArc(), GERBER_PLOTTER::ThickArc(), and EDA_SHAPE::TransformShapeToPolygon().

◆ GetClass()

virtual wxString LIB_TEXTBOX::GetClass ( ) const

inlineoverridevirtual

Return the class name.

Reimplemented from LIB_SHAPE.

Definition at line 49 of file lib_textbox.h.

 {
 return wxT( "LIB_TEXTBOX" );
 }

◆ GetConvert()

int LIB_ITEM::GetConvert ( ) const

inlineinherited

Definition at line 276 of file lib_item.h.

276{ return m_convert; }

LIB_ITEM::m_convert

int m_convert

Shape identification for alternate body styles.

Definition: lib_item.h:333

References LIB_ITEM::m_convert.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), SCH_PIN::GetMsgPanelInfo(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDITOR_MOVE_TOOL::Main(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SYMBOL_EDITOR_PIN_TOOL::PlacePin(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EE_SELECTION_TOOL::Selectable(), sort_by_pin_number(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ GetDefaultFont()

const wxString & LIB_ITEM::GetDefaultFont ( ) const

inherited

Definition at line 128 of file lib_item.cpp.

{
 EESCHEMA_SETTINGS* cfg = Pgm().GetSettingsManager().GetAppSettings<EESCHEMA_SETTINGS>();
 
 return cfg->m_Appearance.default_font;
}

References EESCHEMA_SETTINGS::APPEARANCE::default_font, EESCHEMA_SETTINGS::m_Appearance, and Pgm().

Referenced by LIB_FIELD::getDrawFont(), LIB_TEXT::getDrawFont(), getDrawFont(), and GetShownText().

◆ getDrawFont()

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

overrideprotectedvirtual

Reimplemented from EDA_TEXT.

Definition at line 214 of file lib_textbox.cpp.

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

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

◆ GetDrawPos()

VECTOR2I LIB_TEXTBOX::GetDrawPos ( ) const

overridevirtual

Reimplemented from EDA_TEXT.

Definition at line 107 of file lib_textbox.cpp.

{
 int margin = GetTextMargin();
 BOX2I bbox( VECTOR2I( std::min( m_start.x, m_end.x ), std::min( -m_start.y, -m_end.y ) ),
 VECTOR2I( abs( m_end.x - m_start.x ), abs( m_end.y - m_start.y ) ) );
 
 VECTOR2I pos( bbox.GetLeft() + margin, bbox.GetBottom() - margin );
 
 if( GetTextAngle() == ANGLE_VERTICAL )
 {
 switch( GetHorizJustify() )
 {
 case GR_TEXT_H_ALIGN_LEFT:
 pos.y = bbox.GetBottom() - margin;
 break;
 case GR_TEXT_H_ALIGN_CENTER:
 pos.y = ( bbox.GetTop() + bbox.GetBottom() ) / 2;
 break;
 case GR_TEXT_H_ALIGN_RIGHT:
 pos.y = bbox.GetTop() + margin;
 break;
 }
 
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 pos.x = bbox.GetLeft() + margin;
 break;
 case GR_TEXT_V_ALIGN_CENTER:
 pos.x = ( bbox.GetLeft() + bbox.GetRight() ) / 2;
 break;
 case GR_TEXT_V_ALIGN_BOTTOM:
 pos.x = bbox.GetRight() - margin;
 break;
 }
 }
 else
 {
 switch( GetHorizJustify() )
 {
 case GR_TEXT_H_ALIGN_LEFT:
 pos.x = bbox.GetLeft() + margin;
 break;
 case GR_TEXT_H_ALIGN_CENTER:
 pos.x = ( bbox.GetLeft() + bbox.GetRight() ) / 2;
 break;
 case GR_TEXT_H_ALIGN_RIGHT:
 pos.x = bbox.GetRight() - margin;
 break;
 }
 
 switch( GetVertJustify() )
 {
 case GR_TEXT_V_ALIGN_TOP:
 pos.y = bbox.GetTop() + margin;
 break;
 case GR_TEXT_V_ALIGN_CENTER:
 pos.y = ( bbox.GetTop() + bbox.GetBottom() ) / 2;
 break;
 case GR_TEXT_V_ALIGN_BOTTOM:
 pos.y = bbox.GetBottom() - margin;
 break;
 }
 }
 
 return pos;
}

References std::abs(), ANGLE_VERTICAL, BOX2< Vec >::GetBottom(), EDA_TEXT::GetHorizJustify(), BOX2< Vec >::GetLeft(), BOX2< Vec >::GetRight(), EDA_TEXT::GetTextAngle(), GetTextMargin(), BOX2< Vec >::GetTop(), EDA_TEXT::GetVertJustify(), 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_SHAPE::m_end, EDA_SHAPE::m_start, VECTOR2< T >::x, and VECTOR2< T >::y.

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

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

◆ GetEffectiveLineStyle()

PLOT_DASH_TYPE LIB_SHAPE::GetEffectiveLineStyle ( ) const

inlineinherited

Definition at line 60 of file lib_shape.h.

 {
 if( m_stroke.GetPlotStyle() == PLOT_DASH_TYPE::DEFAULT )
 return PLOT_DASH_TYPE::SOLID;
 else
 return m_stroke.GetPlotStyle();
 }

References DEFAULT, STROKE_PARAMS::GetPlotStyle(), EDA_SHAPE::m_stroke, and SOLID.

Referenced by LIB_SHAPE::print().

◆ GetEffectivePenWidth()

virtual int LIB_ITEM::GetEffectivePenWidth ( const RENDER_SETTINGS * aSettings ) const

inlinevirtualinherited

Definition at line 155 of file lib_item.h.

 {
 // For historical reasons, a stored value of 0 means "default width" and negative
 // numbers meant "don't stroke".
 
 if( GetPenWidth() < 0 )
 return 0;
 else if( GetPenWidth() == 0 )
 return std::max( aSettings->GetDefaultPenWidth(), aSettings->GetMinPenWidth() );
 else
 return std::max( GetPenWidth(), aSettings->GetMinPenWidth() );
 }

References KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::GetMinPenWidth(), and LIB_ITEM::GetPenWidth().

Referenced by LIB_FIELD::Plot(), LIB_SHAPE::Plot(), Plot(), LIB_PIN::PlotSymbol(), LIB_FIELD::print(), LIB_SHAPE::print(), print(), and LIB_PIN::printPinSymbol().

◆ GetEffectiveTextPenWidth()

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

inherited

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

Definition at line 299 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(), PCB_TEXT::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(), Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_TEXT::print(), print(), EDA_TEXT::printOneLineOfText(), FP_TEXT::TransformTextToPolySet(), FP_TEXTBOX::TransformTextToPolySet(), PCB_TEXT::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 855 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 PCB_DIMENSION_BASE::GetEffectiveShape(), FP_TEXT::GetEffectiveShape(), FP_TEXTBOX::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), PCB_TEXTBOX::GetEffectiveShape(), PCB_SELECTION_TOOL::hitTestDistance(), PNS_KICAD_IFACE_BASE::syncTextItem(), and EDA_TEXT::TransformBoundingBoxToPolygon().

◆ GetEffectiveWidth()

virtual int EDA_SHAPE::GetEffectiveWidth ( ) const

inlinevirtualinherited

Reimplemented in SCH_SHAPE.

Definition at line 110 of file eda_shape.h.

110{ return GetWidth(); }

References EDA_SHAPE::GetWidth().

Referenced by EDA_SHAPE::makeEffectiveShapes().

◆ GetEnd()

const VECTOR2I & EDA_SHAPE::GetEnd ( ) const

inlineinherited

Return the ending point of the graphic.

Definition at line 145 of file eda_shape.h.

145{ return m_end; }

References EDA_SHAPE::m_end.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), BOOST_AUTO_TEST_CASE(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::calcEdit(), KI_TEST::CheckFpShape(), ConvertOutlineToPolygon(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), DRAWING_TOOL::DrawLine(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_PLUGIN::format(), formatArc(), formatBezier(), formatRect(), EDA_SHAPE::GetBotRight(), FP_TEXTBOX::GetBotRight(), PCB_TEXTBOX::GetBotRight(), EDA_SHAPE::getBoundingBox(), EDA_SHAPE::GetLength(), GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), EDA_SHAPE::GetRectCorners(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), GetShownText(), SCH_TEXTBOX::GetShownText(), CONVERT_TOOL::getStartEndPoints(), FP_TEXTBOX::GetTopLeft(), PCB_TEXTBOX::GetTopLeft(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), EDIT_POINTS_FACTORY::Make(), EDA_SHAPE::makeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromChainedSegs(), GRAPHICS_CLEANER::mergeRects(), LIB_SHAPE::Normalize(), SCH_SHAPE::Normalize(), PCB_SHAPE::NormalizeRect(), PCB_PARSER::parsePAD(), SCH_EDITOR_CONTROL::Paste(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_SHAPE::Print(), SCH_TEXTBOX::Print(), SCH_SHAPE::PrintBackground(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), EDA_SHAPE::ShapeGetMsgPanelInfo(), PLOTTER::ThickArc(), GERBER_PLOTTER::ThickArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeToPolygon(), EE_POINT_EDITOR::updatePoints(), and PCB_POINT_EDITOR::updatePoints().

◆ GetEndX()

int EDA_SHAPE::GetEndX ( ) const

inlineinherited

Definition at line 147 of file eda_shape.h.

147{ return m_end.x; }

References EDA_SHAPE::m_end, and VECTOR2< T >::x.

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

◆ GetEndY()

int EDA_SHAPE::GetEndY ( ) const

inlineinherited

Definition at line 146 of file eda_shape.h.

146{ return m_end.y; }

References EDA_SHAPE::m_end, and VECTOR2< T >::y.

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

◆ GetFillColor()

COLOR4D EDA_SHAPE::GetFillColor ( ) const

inlineinherited

Definition at line 105 of file eda_shape.h.

105{ return m_fillColor; }

EDA_SHAPE::m_fillColor

COLOR4D m_fillColor

Definition: eda_shape.h:367

References EDA_SHAPE::m_fillColor.

Referenced by SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_SHAPE::Plot(), LIB_SHAPE::Plot(), SCH_SHAPE::Print(), LIB_SHAPE::print(), print(), SCH_TEXTBOX::Print(), SCH_SHAPE::PrintBackground(), SCH_SEXPR_PLUGIN::saveShape(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), KIGFX::SCH_PAINTER::setDeviceColors(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataToWindow().

◆ GetFillMode()

FILL_T EDA_SHAPE::GetFillMode ( ) const

inlineinherited

Definition at line 101 of file eda_shape.h.

101{ return m_fill; }

References EDA_SHAPE::m_fill.

Referenced by KI_TEST::CheckFpShape(), KIGFX::SCH_PAINTER::draw(), SCH_DRAWING_TOOLS::DrawShape(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), EDA_SHAPE::IsFilled(), CONVERT_TOOL::makePolysFromClosedGraphics(), SCH_SHAPE::Print(), LIB_SYMBOL::Print(), LIB_SHAPE::print(), print(), SCH_TEXTBOX::Print(), SCH_SHAPE::PrintBackground(), LIB_SYMBOL::PrintBackground(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN::saveShape(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), KIGFX::SCH_PAINTER::setDeviceColors(), and DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow().

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

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

◆ GetFriendlyName() [2/2]

wxString EDA_SHAPE::GetFriendlyName ( ) const

inherited

Definition at line 611 of file eda_shape.cpp.

{
 switch( m_shape )
 {
 case SHAPE_T::CIRCLE: return _( "Circle" );
 case SHAPE_T::ARC: return _( "Arc" );
 case SHAPE_T::BEZIER: return _( "Curve" );
 case SHAPE_T::POLY: return _( "Polygon" );
 case SHAPE_T::RECT: return IsAnnotationProxy() ? _( "Pad Number Box" ) : _( "Rectangle" );
 case SHAPE_T::SEGMENT: return _( "Segment" );
 default: return _( "Unrecognized" );
 }
}

References _, ARC, BEZIER, CIRCLE, EDA_SHAPE::IsAnnotationProxy(), EDA_SHAPE::m_shape, POLY, RECT, and SEGMENT.

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

◆ 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(), 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(), 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(), PCB_TEXT::Mirror(), LIB_TEXT::MirrorHorizontal(), MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), LIB_TEXT::NormalizeJustification(), SCH_FIELD::Plot(), 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(), DIALOG_DIMENSION_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 499 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 LIB_TEXTBOX::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 LIB_SHAPE.

Definition at line 374 of file lib_textbox.cpp.

{
 return wxString::Format( _( "Graphic Text Box" ) );
}

References _, and Format().

◆ GetLength()

double EDA_SHAPE::GetLength ( ) const

inherited

Return the length of the track using the hypotenuse calculation.

Returns: the length of the track

Definition at line 110 of file eda_shape.cpp.

{
 double length = 0.0;
 
 switch( m_shape )
 {
 case SHAPE_T::BEZIER:
 for( size_t ii = 1; ii < m_bezierPoints.size(); ++ii )
 length += GetLineLength( m_bezierPoints[ ii - 1], m_bezierPoints[ii] );
 
 return length;
 
 case SHAPE_T::SEGMENT:
 return GetLineLength( GetStart(), GetEnd() );
 
 case SHAPE_T::POLY:
 for( int ii = 0; ii < m_poly.COutline( 0 ).SegmentCount(); ii++ )
 length += m_poly.COutline( 0 ).CSegment( ii ).Length();
 
 return length;
 
 case SHAPE_T::ARC:
 return GetRadius() * GetArcAngle().AsRadians();
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return 0.0;
 }
}

References ARC, EDA_ANGLE::AsRadians(), BEZIER, SHAPE_POLY_SET::COutline(), SHAPE_LINE_CHAIN::CSegment(), EDA_SHAPE::GetArcAngle(), EDA_SHAPE::GetEnd(), GetLineLength(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetStart(), SEG::Length(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, POLY, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by DRAWING_TOOL::drawShape(), and EDA_SHAPE::ShapeGetMsgPanelInfo().

◆ 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 673 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 LIB_TEXTBOX::GetMenuImage ( ) const

overridevirtual

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

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

Returns: The menu image associated with the item.

Reimplemented from LIB_SHAPE.

Definition at line 380 of file lib_textbox.cpp.

{
 return BITMAPS::add_textbox;
}

References add_textbox.

◆ GetMsgPanelInfo()

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

overridevirtual

Display basic info (type, part and convert) about the current item in message panel.

This base function is used to display the information common to the all library items. Call the base class from the derived class or the common information will not be updated in the message panel.

Parameters

aList is the list to populate.

Reimplemented from LIB_SHAPE.

Definition at line 480 of file lib_textbox.cpp.

{
 // Don't use GetShownText() here; we want to show the user the variable references
 aList.emplace_back( _( "Text Box" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
 
 aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
 
 wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) };
 int style = IsBold() && IsItalic() ? 3 : IsBold() ? 2 : IsItalic() ? 1 : 0;
 aList.emplace_back( _( "Style" ), textStyle[style] );
 
 aList.emplace_back( _( "Text Size" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
 
 aList.emplace_back( _( "Box Width" ),
 aFrame->MessageTextFromValue( std::abs( GetEnd().x - GetStart().x ) ) );
 
 aList.emplace_back( _( "Box Height" ),
 aFrame->MessageTextFromValue( std::abs( GetEnd().y - GetStart().y ) ) );
 
 m_stroke.GetMsgPanelInfo( aFrame, aList );
}

References _, std::abs(), KIUI::EllipsizeStatusText(), EDA_SHAPE::GetEnd(), EDA_TEXT::GetFont(), STROKE_PARAMS::GetMsgPanelInfo(), EDA_SHAPE::GetStart(), EDA_TEXT::GetText(), EDA_TEXT::GetTextWidth(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), EDA_SHAPE::m_stroke, and UNITS_PROVIDER::MessageTextFromValue().

◆ GetParent()

LIB_SYMBOL * LIB_ITEM::GetParent ( void ) const

inlineinherited

Definition at line 168 of file lib_item.h.

 {
 return (LIB_SYMBOL*) m_parent;
 }

References EDA_ITEM::m_parent.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_EDIT_TOOL::editFieldProperties(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), LIB_PIN::GetBoundingBox(), LIB_FIELD::GetFullText(), LIB_PIN::IsGlobalPower(), LIB_PIN::Plot(), LIB_PIN::print(), SYMBOL_EDITOR_EDIT_TOOL::Properties(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

◆ getParentOrientation()

EDA_ANGLE LIB_SHAPE::getParentOrientation ( ) const

inlineoverrideprivatevirtualinherited

Implements EDA_SHAPE.

Definition at line 132 of file lib_shape.h.

132{ return ANGLE_0; }

References ANGLE_0.

◆ getParentPosition()

VECTOR2I LIB_SHAPE::getParentPosition ( ) const

inlineoverrideprivatevirtualinherited

Implements EDA_SHAPE.

Definition at line 133 of file lib_shape.h.

133{ return VECTOR2I(); }

◆ GetPenWidth()

int LIB_SHAPE::GetPenWidth ( ) const

overridevirtualinherited

Implements LIB_ITEM.

Definition at line 269 of file lib_shape.cpp.

{
 return GetWidth();
}

References EDA_SHAPE::GetWidth().

◆ GetPointCount()

int EDA_SHAPE::GetPointCount ( ) const

inherited

Returns: the number of corners of the polygonal shape

Definition at line 1254 of file eda_shape.cpp.

{
 // return the number of corners of the polygonal shape
 // this shape is expected to be only one polygon without hole
 if( GetPolyShape().OutlineCount() )
 return GetPolyShape().VertexCount( 0 );
 
 return 0;
}

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

Referenced by GRAPHICS_CLEANER::isNullShape(), SCH_SEXPR_PARSER::ParseSchematic(), and EE_POINT_EDITOR::updatePoints().

◆ GetPolyShape() [1/2]

SHAPE_POLY_SET & EDA_SHAPE::GetPolyShape ( )

inlineinherited

Definition at line 247 of file eda_shape.h.

247{ return m_poly; }

References EDA_SHAPE::m_poly.

Referenced by EE_POINT_EDITOR::addCorner(), PCB_POINT_EDITOR::addCorner(), KI_TEST::CheckFpShape(), ConvertOutlineToPolygon(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::DIALOG_PAD_PRIMITIVE_POLY_PROPS(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), PCB_PLUGIN::format(), formatPoly(), PCB_SHAPE::GetCorners(), PCB_SHAPE::GetFocusPosition(), CADSTAR_PCB_ARCHIVE_LOADER::getKiCadPad(), EDA_SHAPE::GetPointCount(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), ALTIUM_PCB::HelperShapeSetLocalCoord(), EDA_SHAPE::IsPolyShapeValid(), SCH_EAGLE_PLUGIN::loadSymbolPolyLine(), EDIT_POINTS_FACTORY::Make(), EDA_SHAPE::makeEffectiveShapes(), PCB_POINT_EDITOR::makePoints(), FOOTPRINT::cmp_drawings::operator()(), EAGLE_PLUGIN::packagePolygon(), PCB_PARSER::parsePAD(), SCH_SEXPR_PARSER::ParseSchematic(), SCH_EDITOR_CONTROL::Paste(), BRDITEMS_PLOTTER::PlotPcbShape(), EE_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCorner(), EE_POINT_EDITOR::removeCornerCondition(), PCB_POINT_EDITOR::removeCornerCondition(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), EDA_SHAPE::ShapeGetMsgPanelInfo(), shapesNeedUpdate(), PCB_POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updateParentItem(), and EE_POINT_EDITOR::updatePoints().

◆ GetPolyShape() [2/2]

const SHAPE_POLY_SET & EDA_SHAPE::GetPolyShape ( ) const

inlineinherited

Definition at line 248 of file eda_shape.h.

248{ return m_poly; }

References EDA_SHAPE::m_poly.

◆ getPosition()

VECTOR2I EDA_SHAPE::getPosition ( ) const

protectedinherited

Definition at line 99 of file eda_shape.cpp.

{
 if( m_shape == SHAPE_T::ARC )
 return getCenter();
 else if( m_shape == SHAPE_T::POLY )
 return m_poly.CVertex( 0 );
 else
 return m_start;
}

References ARC, SHAPE_POLY_SET::CVertex(), EDA_SHAPE::getCenter(), EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, and POLY.

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

◆ GetPosition()

VECTOR2I LIB_SHAPE::GetPosition ( ) const

inlineoverridevirtualinherited

Reimplemented from EDA_ITEM.

Definition at line 85 of file lib_shape.h.

85{ return getPosition(); }

EDA_SHAPE::getPosition

VECTOR2I getPosition() const

Definition: eda_shape.cpp:99

References EDA_SHAPE::getPosition().

Referenced by KIGFX::SCH_PAINTER::draw(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), HelperGeneratePowerPortGraphics(), SCH_EAGLE_PLUGIN::loadSymbolRectangle(), EDIT_POINTS_FACTORY::Make(), LIB_SHAPE::Normalize(), SCH_ALTIUM_PLUGIN::ParseArc(), SCH_ALTIUM_PLUGIN::ParseEllipse(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), and EE_POINT_EDITOR::updatePoints().

◆ GetRadius()

int EDA_SHAPE::GetRadius ( ) const

inherited

Definition at line 523 of file eda_shape.cpp.

{
 double radius = 0.0;
 
 switch( m_shape )
 {
 case SHAPE_T::ARC:
 radius = GetLineLength( m_arcCenter, m_start );
 break;
 
 case SHAPE_T::CIRCLE:
 radius = GetLineLength( m_start, m_end );
 break;
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 }
 
 // don't allow degenerate circles/arcs
 return std::max( 1, KiROUND( radius ) );
}

References ARC, CIRCLE, GetLineLength(), KiROUND(), EDA_SHAPE::m_arcCenter, EDA_SHAPE::m_end, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by BOARD_ADAPTER::addShape(), EDA_SHAPE::calcEdit(), EDA_SHAPE::computeArcBBox(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), formatCircle(), EDA_SHAPE::getBoundingBox(), PCB_SHAPE::GetFocusPosition(), LIB_SHAPE::GetItemDescription(), SCH_SHAPE::GetItemDescription(), EDA_SHAPE::GetLength(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), EDA_SHAPE::makeEffectiveShapes(), DSN::SPECCTRA_DB::makeIMAGE(), ALTIUM_PCB::Parse(), PCB_PARSER::parsePAD(), SCH_SHAPE::Plot(), LIB_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_SHAPE::Print(), LIB_SHAPE::print(), SCH_SHAPE::PrintBackground(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), EDA_SHAPE::scale(), EDA_SHAPE::ShapeGetMsgPanelInfo(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and EDA_SHAPE::TransformShapeToPolygon().

◆ GetRectCorners()

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

inherited

Definition at line 1035 of file eda_shape.cpp.

{
 std::vector<VECTOR2I> pts;
 VECTOR2I topLeft = GetStart();
 VECTOR2I botRight = GetEnd();
 
 // Un-rotate rect topLeft and botRight
 if( !getParentOrientation().IsCardinal() )
 {
 topLeft -= getParentPosition();
 RotatePoint( topLeft, -getParentOrientation() );
 
 botRight -= getParentPosition();
 RotatePoint( botRight, -getParentOrientation() );
 }
 
 // Set up the un-rotated 4 corners
 pts.emplace_back( topLeft );
 pts.emplace_back( botRight.x, topLeft.y );
 pts.emplace_back( botRight );
 pts.emplace_back( topLeft.x, botRight.y );
 
 // Now re-rotate the 4 corners to get a diamond
 if( !getParentOrientation().IsCardinal() )
 {
 for( VECTOR2I& pt : pts )
 {
 RotatePoint( pt, getParentOrientation() );
 pt += getParentPosition();
 }
 }
 
 return pts;
}

References EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), EDA_SHAPE::GetStart(), RotatePoint(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOARD_ADAPTER::addShape(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE::getBoundingBox(), PCB_SHAPE::GetCorners(), EDA_SHAPE::hitTest(), EDA_SHAPE::makeEffectiveShapes(), SCH_EDITOR_CONTROL::Paste(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), EDA_SHAPE::TransformShapeToPolygon(), FP_TEXTBOX::TransformShapeToPolygon(), and PCB_TEXTBOX::TransformShapeToPolygon().

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

◆ GetShape()

SHAPE_T EDA_SHAPE::GetShape ( ) const

inlineinherited

Definition at line 113 of file eda_shape.h.

113{ return m_shape; }

References EDA_SHAPE::m_shape.

Referenced by PCB_POINT_EDITOR::addCorner(), EE_POINT_EDITOR::addCornerCondition(), LIB_SHAPE::AddPoint(), SCH_SHAPE::AddPoint(), BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), EDA_SHAPE::beginEdit(), EDA_SHAPE::calcEdit(), PCB_POINT_EDITOR::canAddCorner(), KI_TEST::CheckFpShape(), EDA_SHAPE::continueEdit(), ConvertOutlineToPolygon(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), EDA_SHAPE::endEdit(), PAD_TOOL::explodePad(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), FP_SHAPE::Flip(), FootprintWriteShape(), PCB_PLUGIN::format(), PCB_SHAPE::GetCorners(), FP_TEXTBOX::GetCorners(), FOOTPRINT::GetCoverageArea(), LIB_SHAPE::GetItemDescription(), SCH_SHAPE::GetItemDescription(), LIB_SHAPE::GetMenuImage(), SCH_SHAPE::GetMenuImage(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), CONVERT_TOOL::getStartEndPoints(), EE_SELECTION_TOOL::GuessSelectionCandidates(), hash_fp_item(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), EE_POINT_EDITOR::Main(), EDIT_POINTS_FACTORY::Make(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromChainedSegs(), GRAPHICS_CLEANER::mergeRects(), PCB_SHAPE::Mirror(), FP_SHAPE::Mirror(), FP_SHAPE::Move(), LIB_SHAPE::Normalize(), SCH_SHAPE::Normalize(), PCB_SHAPE::cmp_drawings::operator()(), FOOTPRINT::cmp_drawings::operator()(), ALTIUM_PCB::Parse(), SCH_EDITOR_CONTROL::Paste(), SCH_SHAPE::Plot(), LIB_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_SHAPE::Print(), LIB_SHAPE::print(), SCH_SHAPE::PrintBackground(), PAD_TOOL::RecombinePad(), PCB_POINT_EDITOR::removeCorner(), PCB_POINT_EDITOR::removeCornerCondition(), PCB_TEXTBOX::Rotate(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_SEXPR_PLUGIN::saveShape(), SCH_LEGACY_PLUGIN_CACHE::SaveSymbol(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), shapesNeedUpdate(), GERBER_PLOTTER::ThickArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), PCB_POINT_EDITOR::updateItem(), EE_POINT_EDITOR::updateParentItem(), EE_POINT_EDITOR::updatePoints(), PCB_POINT_EDITOR::updatePoints(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::Validate().

◆ GetShownText()

wxString LIB_TEXTBOX::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 330 of file lib_textbox.cpp.

{
 wxString text = EDA_TEXT::GetShownText();
 
 KIFONT::FONT* font = GetFont();
 VECTOR2D size = GetEnd() - GetStart();
 int colWidth = GetTextAngle() == ANGLE_HORIZONTAL ? size.x : size.y;
 
 if( !font )
 font = KIFONT::FONT::GetFont( GetDefaultFont(), IsBold(), IsItalic() );
 
 colWidth = abs( colWidth ) - GetTextMargin() * 2;
 font->LinebreakText( text, colWidth, GetTextSize(), GetTextThickness(), IsBold(), IsItalic() );
 
 return text;
}

References std::abs(), ANGLE_HORIZONTAL, LIB_ITEM::GetDefaultFont(), EDA_SHAPE::GetEnd(), EDA_TEXT::GetFont(), KIFONT::FONT::GetFont(), EDA_TEXT::GetShownText(), EDA_SHAPE::GetStart(), EDA_TEXT::GetTextAngle(), GetTextMargin(), EDA_TEXT::GetTextSize(), EDA_TEXT::GetTextThickness(), EDA_TEXT::IsBold(), EDA_TEXT::IsItalic(), KIFONT::FONT::LinebreakText(), text, VECTOR2< T >::x, and VECTOR2< T >::y.

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

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

◆ GetStart()

const VECTOR2I & EDA_SHAPE::GetStart ( ) const

inlineinherited

Return the starting point of the graphic.

Definition at line 120 of file eda_shape.h.

120{ return m_start; }

References EDA_SHAPE::m_start.

Referenced by PCB_POINT_EDITOR::addCorner(), BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), BOOST_AUTO_TEST_CASE(), EDA_SHAPE::CalcArcAngles(), EDA_SHAPE::calcEdit(), KI_TEST::CheckFpShape(), ALTIUM_PCB::ConvertArcs6ToBoardItemOnLayer(), ConvertOutlineToPolygon(), CreateBoardSection(), MICROWAVE_TOOL::createMicrowaveInductor(), KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::editArcEndpointKeepCenter(), PCB_POINT_EDITOR::editArcEndpointKeepTangent(), PCB_PLUGIN::format(), formatArc(), formatBezier(), formatCircle(), formatRect(), FP_TEXTBOX::GetBotRight(), PCB_TEXTBOX::GetBotRight(), EDA_SHAPE::getBoundingBox(), PCB_SHAPE::GetFocusPosition(), EDA_SHAPE::GetLength(), GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), EDA_SHAPE::GetRectCorners(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), GetShownText(), SCH_TEXTBOX::GetShownText(), CONVERT_TOOL::getStartEndPoints(), EDA_SHAPE::GetTopLeft(), FP_TEXTBOX::GetTopLeft(), PCB_TEXTBOX::GetTopLeft(), hash_fp_item(), EDA_SHAPE::hitTest(), idf_export_outline(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadArc(), EDIT_POINTS_FACTORY::Make(), DSN::SPECCTRA_DB::makeIMAGE(), PCB_POINT_EDITOR::makePoints(), CONVERT_TOOL::makePolysFromChainedSegs(), GRAPHICS_CLEANER::mergeRects(), PCB_SHAPE::NormalizeRect(), PCB_PARSER::parsePAD(), SCH_EDITOR_CONTROL::Paste(), SCH_SHAPE::Plot(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), BRDITEMS_PLOTTER::PlotPcbTarget(), SCH_SHAPE::Print(), SCH_TEXTBOX::Print(), SCH_SHAPE::PrintBackground(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), SCH_SEXPR_PLUGIN::saveTextBox(), EDA_SHAPE::ShapeGetMsgPanelInfo(), PLOTTER::ThickArc(), GERBER_PLOTTER::ThickArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), EDA_SHAPE::TransformShapeToPolygon(), EE_POINT_EDITOR::updatePoints(), and PCB_POINT_EDITOR::updatePoints().

◆ GetStartX()

int EDA_SHAPE::GetStartX ( ) const

inlineinherited

Definition at line 122 of file eda_shape.h.

122{ return m_start.x; }

References EDA_SHAPE::m_start, and VECTOR2< T >::x.

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

◆ GetStartY()

int EDA_SHAPE::GetStartY ( ) const

inlineinherited

Definition at line 121 of file eda_shape.h.

121{ return m_start.y; }

References EDA_SHAPE::m_start, and VECTOR2< T >::y.

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

◆ 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 LIB_SHAPE::GetStroke ( ) const

inlineinherited

Definition at line 52 of file lib_shape.h.

52{ return m_stroke; }

References EDA_SHAPE::m_stroke.

Referenced by KIGFX::SCH_PAINTER::draw(), SYMBOL_EDITOR_DRAWING_TOOLS::DrawShape(), KIGFX::SCH_PAINTER::getRenderColor(), DIALOG_LIB_SHAPE_PROPERTIES::onFill(), LIB_SHAPE::Plot(), Plot(), LIB_SHAPE::print(), print(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), and DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow().

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

◆ 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(), 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(), PCB_TEXT::Flip(), PCB_TEXTBOX::Flip(), PCB_PLUGIN::format(), SCH_LABEL::GetBodyBoundingBox(), LIB_FIELD::GetBoundingBox(), LIB_TEXT::GetBoundingBox(), SCH_FIELD::GetBoundingBox(), SCH_TEXT::GetBoundingBox(), PCB_TEXT::GetBoundingBox(), GetDrawPos(), SCH_TEXTBOX::GetDrawPos(), EDA_TEXT::GetDrawRotation(), SCH_FIELD::GetDrawRotation(), FP_TEXT::GetDrawRotation(), FP_TEXTBOX::GetDrawRotation(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), 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(), PCB_TEXT::Mirror(), PCB_DIMENSION_BASE::Mirror(), LIB_TEXT::MirrorHorizontal(), MirrorHorizontally(), SCH_TEXTBOX::MirrorHorizontally(), LIB_TEXT::MirrorVertical(), MirrorVertically(), SCH_TEXTBOX::MirrorVertically(), LIB_TEXT::NormalizeJustification(), KI_TEST::kitest_cmp_drawings::operator()(), EAGLE_PLUGIN::orientFPText(), SCH_FIELD::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), positioningChanged(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), SCH_EDIT_TOOL::Rotate(), SCH_TEXTBOX::Rotate(), Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), FP_TEXTBOX::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::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(), FP_TEXTBOX::SetTextAngle(), PCB_TEXTBOX::SetTextAngle(), textsNeedUpdate(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_DIMENSION_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 505 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
 VECTOR2I textsize = VECTOR2I( 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.

◆ 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(), Plot(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), 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(), compare(), SCH_GLOBALLABEL::CreateGraphicShape(), SCH_HIERLABEL::CreateGraphicShape(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), SCH_HIERLABEL::GetBodyBoundingBox(), EDA_TEXT::GetInterline(), PCB_TEXT::getKnockoutMargin(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TEXT::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().

◆ GetTextMargin()

int LIB_TEXTBOX::GetTextMargin ( ) const

Definition at line 64 of file lib_textbox.cpp.

{
 return KiROUND( GetTextSize().y * 0.8 );
}

References EDA_TEXT::GetTextSize(), and KiROUND().

Referenced by GetDrawPos(), and GetShownText().

◆ 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(), PCB_GRID_HELPER::computeAnchors(), SCH_SHEET_PIN::ConstrainOnEdge(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), SCH_LABEL::doIsConnected(), SCH_GLOBALLABEL::doIsConnected(), SCH_HIERLABEL::doIsConnected(), KIGFX::DS_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), FP_TEXT::Flip(), FP_TEXTBOX::Flip(), PCB_TEXT::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(), PCB_TEXT::GetBoundingBox(), SCH_MOVE_TOOL::getConnectedDragItems(), SCH_LABEL_BASE::GetConnectionPoints(), EDA_TEXT::GetDrawPos(), SCH_LABEL_BASE::GetEndPoints(), SCH_SHEET_PIN::GetEndPoints(), SCH_FIELD::GetLibPosition(), LIB_FIELD::GetPosition(), LIB_TEXT::GetPosition(), SCH_FIELD::GetPosition(), SCH_TEXT::GetPosition(), DS_DRAW_ITEM_TEXT::GetPosition(), FP_TEXT::GetPosition(), PCB_TEXT::GetPosition(), ALTIUM_PCB::HelperParseDimensions6Radial(), LIB_FIELD::HitTest(), LIB_TEXT::HitTest(), CADSTAR_SCH_ARCHIVE_LOADER::loadSymDefIntoLibrary(), PCB_POINT_EDITOR::makePoints(), FP_TEXT::Mirror(), PCB_TEXT::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::processSymbols(), SCH_LABEL_BASE::Rotate(), SCH_SHEET_PIN::Rotate(), SCH_TEXT::Rotate(), LIB_FIELD::Rotate(), LIB_TEXT::Rotate(), FP_TEXT::Rotate(), PCB_DIMENSION_BASE::Rotate(), PCB_TEXT::Rotate(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), FP_TEXT::SetDrawCoord(), FP_TEXT::SetLocalCoord(), FP_TEXT::TextHitTest(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), FP_TEXT::TransformTextToPolySet(), PCB_TEXT::TransformTextToPolySet(), SCH_LABEL_BASE::UpdateDanglingState(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), PCB_POINT_EDITOR::updateItem(), PCB_POINT_EDITOR::updatePoints(), PCB_DIM_RADIAL::updateText(), 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(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), FP_TEXT::GetEffectiveShape(), PCB_TEXT::GetEffectiveShape(), EDA_TEXT::GetEffectiveTextPenWidth(), SCH_LABEL_BASE::GetLabelBoxExpansion(), CADSTAR_SCH_ARCHIVE_LOADER::getScaledLibPart(), GetShownText(), SCH_TEXTBOX::GetShownText(), FP_TEXTBOX::GetShownText(), PCB_TEXTBOX::GetShownText(), EDA_TEXT::GetTextBox(), GetTextMargin(), SCH_TEXTBOX::GetTextMargin(), FP_TEXTBOX::GetTextMargin(), PCB_TEXTBOX::GetTextMargin(), SCH_TEXT::GetTextOffset(), SCH_EAGLE_PLUGIN::loadFieldAttributes(), EAGLE_PLUGIN::orientFPText(), SCH_FIELD::Plot(), SCH_TEXT::Plot(), 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(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), 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 738 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(), CADSTAR_PCB_ARCHIVE_LOADER::drawCadstarText(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), PCB_TEXT::getKnockoutMargin(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), 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(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), 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.

Referenced by LIB_FIELD::compare(), LIB_TEXT::compare(), compare(), DIALOG_FIELD_PROPERTIES::DIALOG_FIELD_PROPERTIES(), EDA_TEXT_DESC::EDA_TEXT_DESC(), EDA_TEXT::Format(), EDA_TEXT::GetEffectiveTextPenWidth(), PCB_TEXT::getKnockoutMargin(), LIB_FIELD::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), SCH_HIERLABEL::GetSchematicTextOffset(), hash_fp_item(), CADSTAR_SCH_ARCHIVE_LOADER::loadDocumentationSymbols(), SCH_EAGLE_PLUGIN::loadTextAttributes(), SCH_LEGACY_PLUGIN_CACHE::saveField(), SCH_LEGACY_PLUGIN::saveField(), SCH_LEGACY_PLUGIN_CACHE::saveText(), SCH_LEGACY_PLUGIN::saveText(), DIALOG_LABEL_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_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(), PCB_DIM_ALIGNED::updateGeometry(), PCB_DIM_ORTHOGONAL::updateGeometry(), PCB_DIM_RADIAL::updateGeometry(), PCB_DIM_LEADER::updateGeometry(), and DIALOG_FIELD_PROPERTIES::updateText().

◆ GetTopLeft()

virtual VECTOR2I EDA_SHAPE::GetTopLeft ( ) const

inlinevirtualinherited

Reimplemented in FP_TEXTBOX, and PCB_TEXTBOX.

Definition at line 167 of file eda_shape.h.

167{ return GetStart(); }

References EDA_SHAPE::GetStart().

Referenced by KIGFX::PCB_PAINTER::draw(), PCB_POINT_EDITOR::makePoints(), and PCB_POINT_EDITOR::updatePoints().

◆ GetTypeDesc()

wxString EDA_ITEM::GetTypeDesc ( ) const

inherited

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

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

◆ GetTypeName()

wxString LIB_SHAPE::GetTypeName ( ) const

inlineoverridevirtualinherited

Provide a user-consumable name of the object type.

Perform localization when called so that run-time language selection works.

Implements LIB_ITEM.

Definition at line 47 of file lib_shape.h.

 {
 return ShowShape();
 }

References EDA_SHAPE::ShowShape().

Referenced by DIALOG_LIB_SHAPE_PROPERTIES::DIALOG_LIB_SHAPE_PROPERTIES().

◆ GetUnit()

int LIB_ITEM::GetUnit ( ) const

inlineinherited

Definition at line 273 of file lib_item.h.

273{ return m_unit; }

LIB_ITEM::m_unit

int m_unit

Unit identification for multiple parts per package.

Definition: lib_item.h:327

References LIB_ITEM::m_unit.

Referenced by SYMBOL_EDITOR_PIN_TOOL::CreateImagePins(), SYMBOL_EDITOR_EDIT_TOOL::DoDelete(), SYMBOL_EDITOR_PIN_TOOL::EditPinProperties(), CADSTAR_SCH_ARCHIVE_LOADER::fixUpLibraryPins(), SCH_SYMBOL::GetEndPoints(), EE_COLLECTOR::Inspect(), KIGFX::SCH_PAINTER::isUnitAndConversionShown(), SYMBOL_EDITOR_MOVE_TOOL::Main(), DIALOG_LIB_EDIT_PIN_TABLE::OnAddRow(), SYMBOL_EDITOR_EDIT_TOOL::Paste(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePin(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), SCH_LEGACY_PLUGIN_CACHE::saveText(), EE_SELECTION_TOOL::Selectable(), PIN_TABLE_DATA_MODEL::SetValue(), sort_by_pin_number(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), and DIALOG_PIN_PROPERTIES::TransferDataToWindow().

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

◆ GetWidth()

int EDA_SHAPE::GetWidth ( ) const

inlineinherited

Definition at line 109 of file eda_shape.h.

109{ return m_stroke.GetWidth(); }

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

Referenced by BOARD_ADAPTER::addShape(), GRAPHICS_CLEANER::areEquivalent(), ConvertOutlineToPolygon(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), FP_SHAPE::Flip(), EDA_SHAPE::getBoundingBox(), FOOTPRINT::GetCoverageArea(), FP_TEXTBOX::GetEffectiveShape(), PCB_TEXTBOX::GetEffectiveShape(), EDA_SHAPE::GetEffectiveWidth(), LIB_SHAPE::GetPenWidth(), SCH_SHAPE::GetPenWidth(), SCH_TEXTBOX::GetTextMargin(), FP_TEXTBOX::GetTextMargin(), PCB_TEXTBOX::GetTextMargin(), hash_fp_item(), EDA_SHAPE::hitTest(), GRAPHICS_CLEANER::isNullShape(), SCH_LEGACY_PLUGIN_CACHE::loadBezier(), FABMASTER::loadOutline(), FABMASTER::loadPolygon(), DSN::SPECCTRA_DB::makeIMAGE(), CONVERT_TOOL::makePolysFromChainedSegs(), PCB_SHAPE::Mirror(), FP_SHAPE::Mirror(), FOOTPRINT::cmp_drawings::operator()(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_LEGACY_PLUGIN_CACHE::saveArc(), SCH_LEGACY_PLUGIN_CACHE::saveBezier(), SCH_LEGACY_PLUGIN_CACHE::saveCircle(), SCH_LEGACY_PLUGIN_CACHE::savePolyLine(), SCH_LEGACY_PLUGIN_CACHE::saveRectangle(), FP_SHAPE::SetDrawCoord(), PLOTTER::ThickArc(), GERBER_PLOTTER::ThickArc(), AR_MATRIX::TraceSegmentPcb(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), EDA_SHAPE::TransformShapeToPolygon(), FP_TEXTBOX::TransformShapeToPolygon(), PCB_TEXTBOX::TransformShapeToPolygon(), PCB_POINT_EDITOR::updateItem(), and PCB_SHAPE::ViewBBox().

◆ 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 1006 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(), BOARD_COMMIT::Push(), SCH_EDIT_TOOL::Rotate(), EE_TOOL_BASE< T >::saveCopyInUndoList(), and EE_SELECTION_TOOL::selectMultiple().

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

◆ 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(), PCB_TEXT::GetShownText(), and PCB_TEXTBOX::GetShownText().

◆ hitTest() [1/2]

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

protectedinherited

Definition at line 859 of file eda_shape.cpp.

{
 BOX2I arect = aRect;
 arect.Normalize();
 arect.Inflate( aAccuracy );
 
 BOX2I bbox = getBoundingBox();
 
 switch( m_shape )
 {
 case SHAPE_T::CIRCLE:
 // Test if area intersects or contains the circle:
 if( aContained )
 {
 return arect.Contains( bbox );
 }
 else
 {
 // If the rectangle does not intersect the bounding box, this is a much quicker test
 if( !arect.Intersects( bbox ) )
 return false;
 else
 return arect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() );
 }
 
 case SHAPE_T::ARC:
 // Test for full containment of this arc in the rect
 if( aContained )
 {
 return arect.Contains( bbox );
 }
 // Test if the rect crosses the arc
 else
 {
 if( !arect.Intersects( bbox ) )
 return false;
 
 if( IsFilled() )
 {
 return ( arect.Intersects( getCenter(), GetStart() )
 || arect.Intersects( getCenter(), GetEnd() )
 || arect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() ) );
 }
 else
 {
 return arect.IntersectsCircleEdge( getCenter(), GetRadius(), GetWidth() );
 }
 }
 
 case SHAPE_T::RECT:
 if( aContained )
 {
 return arect.Contains( bbox );
 }
 else
 {
 std::vector<VECTOR2I> pts = GetRectCorners();
 
 // Account for the width of the lines
 arect.Inflate( GetWidth() / 2 );
 return ( arect.Intersects( pts[0], pts[1] )
 || arect.Intersects( pts[1], pts[2] )
 || arect.Intersects( pts[2], pts[3] )
 || arect.Intersects( pts[3], pts[0] ) );
 }
 
 case SHAPE_T::SEGMENT:
 if( aContained )
 {
 return arect.Contains( GetStart() ) && aRect.Contains( GetEnd() );
 }
 else
 {
 // Account for the width of the line
 arect.Inflate( GetWidth() / 2 );
 return arect.Intersects( GetStart(), GetEnd() );
 }
 
 case SHAPE_T::POLY:
 if( aContained )
 {
 return arect.Contains( bbox );
 }
 else
 {
 // Fast test: if aRect is outside the polygon bounding box,
 // rectangles cannot intersect
 if( !arect.Intersects( bbox ) )
 return false;
 
 // Account for the width of the line
 arect.Inflate( GetWidth() / 2 );
 
 // Polygons in footprints use coordinates relative to the footprint.
 // Therefore, instead of using m_poly, we make a copy which is translated
 // to the actual location in the board.
 VECTOR2I offset = getParentPosition();
 
 for( int ii = 0; ii < m_poly.OutlineCount(); ++ii )
 {
 SHAPE_LINE_CHAIN poly = m_poly.Outline( ii );
 poly.Rotate( getParentOrientation() );
 poly.Move( offset );
 
 int count = poly.GetPointCount();
 
 for( int jj = 0; jj < count; jj++ )
 {
 VECTOR2I vertex = poly.GetPoint( jj );
 
 // Test if the point is within aRect
 if( arect.Contains( vertex ) )
 return true;
 
 if( jj + 1 < count )
 {
 VECTOR2I vertexNext = poly.GetPoint( jj + 1 );
 
 // Test if this edge intersects aRect
 if( arect.Intersects( vertex, vertexNext ) )
 return true;
 }
 else if( poly.IsClosed() )
 {
 VECTOR2I vertexNext = poly.GetPoint( 0 );
 
 // Test if this edge intersects aRect
 if( arect.Intersects( vertex, vertexNext ) )
 return true;
 }
 }
 }
 
 return false;
 }
 
 case SHAPE_T::BEZIER:
 if( aContained )
 {
 return arect.Contains( bbox );
 }
 else
 {
 // Fast test: if aRect is outside the polygon bounding box,
 // rectangles cannot intersect
 if( !arect.Intersects( bbox ) )
 return false;
 
 // Account for the width of the line
 arect.Inflate( GetWidth() / 2 );
 unsigned count = m_bezierPoints.size();
 
 for( unsigned ii = 1; ii < count; ii++ )
 {
 VECTOR2I vertex = m_bezierPoints[ii - 1];
 VECTOR2I vertexNext = m_bezierPoints[ii];
 
 // Test if the point is within aRect
 if( arect.Contains( vertex ) )
 return true;
 
 // Test if this edge intersects aRect
 if( arect.Intersects( vertex, vertexNext ) )
 return true;
 }
 
 return false;
 }
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References ARC, BEZIER, CIRCLE, BOX2< Vec >::Contains(), EDA_SHAPE::getBoundingBox(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::getParentOrientation(), EDA_SHAPE::getParentPosition(), SHAPE_LINE_CHAIN::GetPoint(), SHAPE_LINE_CHAIN::GetPointCount(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetWidth(), BOX2< Vec >::Inflate(), BOX2< Vec >::Intersects(), BOX2< Vec >::IntersectsCircleEdge(), SHAPE_LINE_CHAIN::IsClosed(), EDA_SHAPE::IsFilled(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, SHAPE_LINE_CHAIN::Move(), BOX2< Vec >::Normalize(), SHAPE_POLY_SET::Outline(), SHAPE_POLY_SET::OutlineCount(), POLY, RECT, SHAPE_LINE_CHAIN::Rotate(), SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

◆ HitTest() [1/2]

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

overridevirtual

Test if aRect intersects this item.

Parameters

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

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

Reimplemented from LIB_SHAPE.

Definition at line 361 of file lib_textbox.cpp.

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

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

◆ hitTest() [2/2]

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

protectedinherited

Definition at line 745 of file eda_shape.cpp.

{
 int maxdist = aAccuracy;
 
 if( GetWidth() > 0 )
 maxdist += GetWidth() / 2;
 
 switch( m_shape )
 {
 case SHAPE_T::CIRCLE:
 {
 int radius = GetRadius();
 
 VECTOR2I::extended_type dist = KiROUND<double, VECTOR2I::extended_type>(
 EuclideanNorm( aPosition - getCenter() ) );
 
 if( IsFilled() )
 return dist <= radius + maxdist; // Filled circle hit-test
 else
 return abs( radius - dist ) <= maxdist; // Ring hit-test
 }
 
 case SHAPE_T::ARC:
 {
 if( EuclideanNorm( aPosition - m_start ) <= maxdist )
 return true;
 
 if( EuclideanNorm( aPosition - m_end ) <= maxdist )
 return true;
 
 VECTOR2I relPos = aPosition - getCenter();
 int radius = GetRadius();
 
 VECTOR2I::extended_type dist =
 KiROUND<double, VECTOR2I::extended_type>( EuclideanNorm( relPos ) );
 
 if( IsFilled() )
 {
 // Check distance from arc center
 if( dist > radius + maxdist )
 return false;
 }
 else
 {
 // Check distance from arc circumference
 if( abs( radius - dist ) > maxdist )
 return false;
 }
 
 // Finally, check to see if it's within arc's swept angle.
 EDA_ANGLE startAngle;
 EDA_ANGLE endAngle;
 CalcArcAngles( startAngle, endAngle );
 
 EDA_ANGLE relPosAngle( relPos );
 
 startAngle.Normalize();
 endAngle.Normalize();
 relPosAngle.Normalize();
 
 if( endAngle > startAngle )
 return relPosAngle >= startAngle && relPosAngle <= endAngle;
 else
 return relPosAngle >= startAngle || relPosAngle <= endAngle;
 }
 
 case SHAPE_T::BEZIER:
 const_cast<EDA_SHAPE*>( this )->RebuildBezierToSegmentsPointsList( GetWidth() );
 
 for( unsigned int i= 1; i < m_bezierPoints.size(); i++)
 {
 if( TestSegmentHit( aPosition, m_bezierPoints[ i - 1], m_bezierPoints[i], maxdist ) )
 return true;
 }
 
 return false;
 
 case SHAPE_T::SEGMENT:
 return TestSegmentHit( aPosition, GetStart(), GetEnd(), maxdist );
 
 case SHAPE_T::RECT:
 if( IsAnnotationProxy() || IsFilled() ) // Filled rect hit-test
 {
 SHAPE_POLY_SET poly;
 poly.NewOutline();
 
 for( const VECTOR2I& pt : GetRectCorners() )
 poly.Append( pt );
 
 return poly.Collide( aPosition, maxdist );
 }
 else // Open rect hit-test
 {
 std::vector<VECTOR2I> pts = GetRectCorners();
 
 return TestSegmentHit( aPosition, pts[0], pts[1], maxdist )
 || TestSegmentHit( aPosition, pts[1], pts[2], maxdist )
 || TestSegmentHit( aPosition, pts[2], pts[3], maxdist )
 || TestSegmentHit( aPosition, pts[3], pts[0], maxdist );
 }
 
 case SHAPE_T::POLY:
 if( IsFilled() )
 return m_poly.Collide( aPosition, maxdist );
 else
 return m_poly.CollideEdge( aPosition, nullptr, maxdist );
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References std::abs(), SHAPE_POLY_SET::Append(), ARC, BEZIER, EDA_SHAPE::CalcArcAngles(), CIRCLE, SHAPE_POLY_SET::Collide(), SHAPE_POLY_SET::CollideEdge(), EuclideanNorm(), EDA_SHAPE::getCenter(), EDA_SHAPE::GetEnd(), EDA_SHAPE::GetRadius(), EDA_SHAPE::GetRectCorners(), EDA_SHAPE::GetStart(), EDA_SHAPE::GetWidth(), EDA_SHAPE::IsAnnotationProxy(), EDA_SHAPE::IsFilled(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_end, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, EDA_SHAPE::m_start, SHAPE_POLY_SET::NewOutline(), EDA_ANGLE::Normalize(), POLY, EDA_SHAPE::RebuildBezierToSegmentsPointsList(), RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), TestSegmentHit(), and UNIMPLEMENTED_FOR.

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

◆ HitTest() [2/2]

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

overridevirtual

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

Parameters

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

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

Reimplemented from LIB_SHAPE.

Definition at line 348 of file lib_textbox.cpp.

{
 if( aAccuracy < schIUScale.MilsToIU( MINIMUM_SELECTION_DISTANCE ) )
 aAccuracy = schIUScale.MilsToIU( MINIMUM_SELECTION_DISTANCE );
 
 BOX2I rect = GetBoundingBox();
 
 rect.Inflate( aAccuracy );
 
 return rect.Contains( aPosition );
}

References BOX2< Vec >::Contains(), LIB_SHAPE::GetBoundingBox(), BOX2< Vec >::Inflate(), EDA_IU_SCALE::MilsToIU(), MINIMUM_SELECTION_DISTANCE, and schIUScale.

◆ IsAnnotationProxy()

bool EDA_SHAPE::IsAnnotationProxy ( ) const

inlineinherited

Definition at line 87 of file eda_shape.h.

87{ return m_annotationProxy; }

EDA_SHAPE::m_annotationProxy

bool m_annotationProxy

Definition: eda_shape.h:382

References EDA_SHAPE::m_annotationProxy.

Referenced by KIGFX::PCB_PAINTER::draw(), EDA_SHAPE::GetFriendlyName(), EDA_SHAPE::hitTest(), EDA_SHAPE::makeEffectiveShapes(), PAD_TOOL::RecombinePad(), EDA_SHAPE::ShowShape(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), and EDA_SHAPE::TransformShapeToPolygon().

◆ 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(), 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(), getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), EDA_TEXT::GetEffectiveTextPenWidth(), KIGFX::SCH_PAINTER::getFont(), GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetRenderCache(), 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(), Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), 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(), DIALOG_DIMENSION_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().

◆ IsClosed()

bool EDA_SHAPE::IsClosed ( ) const

inherited

Definition at line 141 of file eda_shape.cpp.

{
 switch( m_shape )
 {
 case SHAPE_T::CIRCLE:
 case SHAPE_T::RECT:
 return true;
 
 case SHAPE_T::ARC:
 case SHAPE_T::SEGMENT:
 return false;
 
 case SHAPE_T::POLY:
 if( m_poly.IsEmpty() )
 return false;
 else
 return m_poly.Outline( 0 ).IsClosed();
 
 case SHAPE_T::BEZIER:
 if( m_bezierPoints.size() < 3 )
 return false;
 else
 return m_bezierPoints[0] == m_bezierPoints[ m_bezierPoints.size() - 1 ];
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_T_asString() );
 return false;
 }
}

References ARC, BEZIER, CIRCLE, SHAPE_LINE_CHAIN::IsClosed(), SHAPE_POLY_SET::IsEmpty(), EDA_SHAPE::m_bezierPoints, EDA_SHAPE::m_poly, EDA_SHAPE::m_shape, SHAPE_POLY_SET::Outline(), POLY, RECT, SEGMENT, EDA_SHAPE::SHAPE_T_asString(), and UNIMPLEMENTED_FOR.

Referenced by CONVERT_TOOL::makePolysFromClosedGraphics(), and CONVERT_TOOL::makePolysFromOpenGraphics().

◆ IsDefaultFormatting()

bool EDA_TEXT::IsDefaultFormatting ( ) const

inherited

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

◆ IsFilled()

bool EDA_SHAPE::IsFilled ( ) const

inlineinherited

Definition at line 90 of file eda_shape.h.

 {
 return GetFillMode() != FILL_T::NO_FILL;
 }

References EDA_SHAPE::GetFillMode(), and NO_FILL.

Referenced by BOARD_ADAPTER::addShape(), EDA_SHAPE::computeArcBBox(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PCB_PLUGIN::format(), FOOTPRINT::GetCoverageArea(), PCB_SHAPE::GetFocusPosition(), hash_fp_item(), EDA_SHAPE::hitTest(), EDA_SHAPE::makeEffectiveShapes(), PCB_PARSER::parsePAD(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), LIB_SHAPE::print(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), KIGFX::SCH_PAINTER::setDeviceColors(), shapesNeedUpdate(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataToWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataToWindow(), and EDA_SHAPE::TransformShapeToPolygon().

◆ 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 1000 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(), 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(), getDrawFont(), SCH_FIELD::getDrawFont(), SCH_TEXT::getDrawFont(), SCH_TEXTBOX::getDrawFont(), KIGFX::SCH_PAINTER::getFont(), GetMsgPanelInfo(), SCH_LABEL_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), SCH_FIELD::GetRenderCache(), 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(), Plot(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), 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(), DIALOG_DIMENSION_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().

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

◆ IsPolyShapeValid()

bool EDA_SHAPE::IsPolyShapeValid ( ) const

inherited

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

Definition at line 1242 of file eda_shape.cpp.

{
 // return true if the polygonal shape is valid (has more than 2 points)
 if( GetPolyShape().OutlineCount() == 0 )
 return false;
 
 const SHAPE_LINE_CHAIN& outline = static_cast<const SHAPE_POLY_SET&>( GetPolyShape() ).Outline( 0 );
 
 return outline.PointCount() > 2;
}

References EDA_SHAPE::GetPolyShape(), and SHAPE_LINE_CHAIN::PointCount().

Referenced by PCB_PLUGIN::format(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), EDA_SHAPE::TransformShapeToPolygon(), and FP_TEXTBOX::TransformShapeToPolygon().

◆ IsPrivate()

bool LIB_ITEM::IsPrivate ( ) const

inlineinherited

Definition at line 279 of file lib_item.h.

279{ return m_private; }

LIB_ITEM::m_private

bool m_private

Private items are shown only in the Symbol Editor.

Definition: lib_item.h:338

References LIB_ITEM::m_private.

Referenced by LIB_ITEM::compare(), KIGFX::SCH_PAINTER::draw(), LIB_ITEM::GetMsgPanelInfo(), LIB_SHAPE::Plot(), LIB_TEXT::Plot(), Plot(), LIB_SHAPE::print(), print(), SCH_SEXPR_PLUGIN_CACHE::saveSymbolDrawItem(), SCH_SEXPR_PLUGIN_CACHE::saveText(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), LIB_SHAPE::ViewGetLayers(), LIB_TEXT::ViewGetLayers(), and ViewGetLayers().

◆ IsReplaceable()

virtual bool LIB_TEXTBOX::IsReplaceable ( ) const

inlineoverridevirtual

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

Definition at line 78 of file lib_textbox.h.

78{ return true; }

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

◆ IsType()

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

inlinevirtualinherited

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 in SCH_FIELD, SCH_ITEM, SCH_LABEL_BASE, SCH_LINE, FP_SHAPE, FP_TEXT, FP_TEXTBOX, PAD, PCB_DIMENSION_BASE, PCB_SHAPE, <

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ COMPARE_FLAGS

◆ LIB_CONVERT

Constructor & Destructor Documentation

◆ LIB_TEXTBOX() [1/2]

◆ LIB_TEXTBOX() [2/2]

◆ ~LIB_TEXTBOX()

Member Function Documentation

◆ AddPoint()

◆ AddRenderCacheGlyph()

◆ beginEdit()

◆ BeginEdit()

◆ buildBezierToSegmentsPointsList()

◆ cacheShownText()

◆ CalcArcAngles()

◆ calcEdit()

◆ CalcEdit()

◆ ClassOf()

◆ ClearBoundingBoxCache()

◆ ClearBrightened()

◆ ClearEditFlags()

◆ ClearFlags()

◆ ClearRenderCache()

◆ ClearSelected()

◆ ClearTempFlags()

◆ ClearViewPrivData()

◆ Clone()

◆ Compare() [1/2]

◆ Compare() [2/2]

◆ compare()

◆ computeArcBBox()

◆ continueEdit()

◆ ContinueEdit()

◆ CopyText()

◆ DupPolyPointsList()

◆ Empty()

◆ EndEdit()

◆ endEdit()

◆ EndsSwapped()

◆ flip()

◆ Format()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetArcAngle()

◆ GetArcMid()

◆ GetAttributes()

◆ GetBezierC1()

◆ GetBezierC2()

◆ GetBezierPoints()

◆ GetBotRight()

◆ getBoundingBox()

◆ GetBoundingBox()

◆ GetCenter()

◆ getCenter()

◆ GetClass()

◆ GetConvert()

◆ GetDefaultFont()

◆ getDrawFont()

◆ GetDrawPos()

◆ GetDrawRotation()

◆ GetEditFlags()

◆ GetEffectiveLineStyle()

◆ GetEffectivePenWidth()

◆ GetEffectiveTextPenWidth()

◆ GetEffectiveTextShape()

◆ GetEffectiveWidth()

◆ GetEnd()

◆ GetEndX()

◆ GetEndY()

◆ GetFillColor()