A pin layout helper is a class that manages the layout of the parts of a pin on a schematic symbol: More...

#include <pin_layout_cache.h>

Classes
struct	TEXT_EXTENTS_CACHE
	Cached extent of a text item. More...

struct	TEXT_INFO

Public Types
enum	DIRTY_FLAGS { NAME = 1 , NUMBER = 2 , ELEC_TYPE = 4 , ALL = NAME \| NUMBER \| ELEC_TYPE }

Public Member Functions
	PIN_LAYOUT_CACHE (const SCH_PIN &aPin)

void	MarkDirty (int aFlags)
	Recompute all the layout information.

void	SetRenderParameters (int aNameThickness, int aNumberThickness, bool aShowElectricalType, bool aShowAltIcons)

BOX2I	GetPinBoundingBox (bool aIncludeLabelsOnInvisiblePins, bool aIncludeNameAndNumber, bool aIncludeElectricalType)
	Get the bounding box of the pin itself.

OPT_BOX2I	GetPinNameBBox ()
	Get the bounding box of the pin name, if there is one.

OPT_BOX2I	GetPinNumberBBox ()
	Get the bounding box of the pin number, if there is one.

OPT_BOX2I	GetAltIconBBox ()
	Get the box of the alt mode icon, if there is one.

CIRCLE	GetDanglingIndicator () const
	Gets the dangling indicator geometry for this pin, if the pin were to be dangling.

std::optional< TEXT_INFO >	GetPinNameInfo (int aShadowWidth)
	Get the text info for the pin name.

std::optional< TEXT_INFO >	GetPinNumberInfo (int aShadowWidth)

std::optional< TEXT_INFO >	GetPinElectricalTypeInfo (int aShadowWidth)

Private Member Functions
bool	isDirty (int aMask) const

void	setClean (int aMask)

void	recomputeCaches ()
	Recompute all the caches that have become dirty.

void	transformBoxForPin (BOX2I &aBox) const
	Transform a box (in-place) to the pin's orientation.

void	transformTextForPin (TEXT_INFO &aTextInfo) const
	Transform text info to suit a pin's.

int	getPinTextOffset () const
	Get the current pin text offset.

int	getNumberBlockOffset () const
	Get the distance from the pin to the centre of the drawn number, measured perpendicular to the pin.

OPT_BOX2I	getUntransformedPinNameBox () const
	Get the untransformd text box in the default orientation.

OPT_BOX2I	getUntransformedPinNumberBox () const

OPT_BOX2I	getUntransformedPinTypeBox () const

OPT_BOX2I	getUntransformedAltIconBox () const

OPT_BOX2I	getUntransformedDecorationBox () const
	Pin type decoration if any.

Static Private Member Functions
static void	recomputeExtentsCache (bool aDefinitelyDirty, KIFONT::FONT *aFont, int aSize, const wxString &aText, const KIFONT::METRICS &aFontMetrics, TEXT_EXTENTS_CACHE &aCache)

Private Attributes
const SCH_PIN &	m_pin
	The pin in question.

const SCHEMATIC_SETTINGS *	m_schSettings

int	m_dirtyFlags

float	m_shadowOffsetAdjust = 1.0f

int	m_nameThickness = 0

int	m_numberThickness = 0

bool	m_showElectricalType = false

bool	m_showAltIcons = false

wxString	m_numSource

int	m_numSourceLength = -1

TEXT_EXTENTS_CACHE	m_numExtentsCache

TEXT_EXTENTS_CACHE	m_nameExtentsCache

TEXT_EXTENTS_CACHE	m_typeExtentsCache

Detailed Description

A pin layout helper is a class that manages the layout of the parts of a pin on a schematic symbol:

including, extents of:

the pin itself
the pin number, number, type
decorations
alternate mode icons

This is useful, because this information is used in multiple places, and regenerating it in multiple places is error-prone. It can also be cached if it's encapsulated in one place.

Definition at line 47 of file pin_layout_cache.h.

Member Enumeration Documentation

◆ DIRTY_FLAGS

enum PIN_LAYOUT_CACHE::DIRTY_FLAGS

Enumerator
NAME
NUMBER
ELEC_TYPE
ALL

Definition at line 52 of file pin_layout_cache.h.

Constructor & Destructor Documentation

◆ PIN_LAYOUT_CACHE()

PIN_LAYOUT_CACHE::PIN_LAYOUT_CACHE ( const SCH_PIN & aPin )

Definition at line 149 of file pin_layout_cache.cpp.

References ALL, m_dirtyFlags, m_pin, m_schSettings, SCH_ITEM::Schematic(), and SCHEMATIC::Settings().

Member Function Documentation

◆ GetAltIconBBox()

OPT_BOX2I PIN_LAYOUT_CACHE::GetAltIconBBox ( )

Get the box of the alt mode icon, if there is one.

Definition at line 752 of file pin_layout_cache.cpp.

References getUntransformedAltIconBox(), and transformBoxForPin().

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

◆ GetDanglingIndicator()

CIRCLE PIN_LAYOUT_CACHE::GetDanglingIndicator ( ) const

Gets the dangling indicator geometry for this pin, if the pin were to be dangling.

Definition at line 495 of file pin_layout_cache.cpp.

References m_pin, and TARGET_PIN_RADIUS.

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

◆ getNumberBlockOffset()

int PIN_LAYOUT_CACHE::getNumberBlockOffset ( ) const

private

Get the distance from the pin to the centre of the drawn number, measured perpendicular to the pin.

A stacked number is a column of lines, so this grows with the line count.

Definition at line 504 of file pin_layout_cache.cpp.

References getPinTextOffset(), KiROUND(), m_numberThickness, m_numExtentsCache, m_pin, PIN_TEXT_MARGIN, schIUScale, and wxStringSplit().

Referenced by GetPinNumberInfo().

◆ GetPinBoundingBox()

BOX2I PIN_LAYOUT_CACHE::GetPinBoundingBox	(	bool	aIncludeLabelsOnInvisiblePins,
		bool	aIncludeNameAndNumber,
		bool	aIncludeElectricalType )

Get the bounding box of the pin itself.

Definition at line 387 of file pin_layout_cache.cpp.

References BOX2< VECTOR2I >::ByCenter(), BOX2< VECTOR2I >::ByCorners(), CIRCLE::Center, SCH_PIN::GetBoundingBox(), GetDanglingIndicator(), getUntransformedAltIconBox(), getUntransformedDecorationBox(), getUntransformedPinNameBox(), getUntransformedPinNumberBox(), getUntransformedPinTypeBox(), BOX2< Vec >::Inflate(), m_pin, BOX2< Vec >::Merge(), BOX2< Vec >::Normalize(), BOX2< Vec >::Offset(), recomputeCaches(), and transformBoxForPin().

Referenced by SCH_PIN::GetBoundingBox().

◆ GetPinElectricalTypeInfo()

std::optional< PIN_LAYOUT_CACHE::TEXT_INFO > PIN_LAYOUT_CACHE::GetPinElectricalTypeInfo ( int aShadowWidth )

Definition at line 872 of file pin_layout_cache.cpp.

References ANGLE_HORIZONTAL, getPinTextOffset(), GR_TEXT_H_ALIGN_RIGHT, GR_TEXT_V_ALIGN_CENTER, info, KiROUND(), m_pin, m_shadowOffsetAdjust, m_showElectricalType, recomputeCaches(), schIUScale, TARGET_PIN_RADIUS, and transformTextForPin().

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

◆ GetPinNameBBox()

OPT_BOX2I PIN_LAYOUT_CACHE::GetPinNameBBox ( )

Get the bounding box of the pin name, if there is one.

Definition at line 728 of file pin_layout_cache.cpp.

References getUntransformedPinNameBox(), recomputeCaches(), and transformBoxForPin().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and SCH_TOOL_BASE< T >::Increment().

◆ GetPinNameInfo()

std::optional< PIN_LAYOUT_CACHE::TEXT_INFO > PIN_LAYOUT_CACHE::GetPinNameInfo ( int aShadowWidth )

Get the text info for the pin name.

If the pin name is not visible, this will return an empty optional.

Definition at line 763 of file pin_layout_cache.cpp.

References ANGLE_HORIZONTAL, ANGLE_VERTICAL, clearance, DefaultTransform, SYMBOL::GetPins(), getPinTextOffset(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_V_ALIGN_CENTER, info, KiROUND(), m_nameThickness, m_pin, m_shadowOffsetAdjust, name, PIN_DOWN, PIN_LEFT, PIN_TEXT_MARGIN, PIN_UP, recomputeCaches(), schIUScale, transformTextForPin(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

◆ GetPinNumberBBox()

OPT_BOX2I PIN_LAYOUT_CACHE::GetPinNumberBBox ( )

Get the bounding box of the pin number, if there is one.

Definition at line 740 of file pin_layout_cache.cpp.

References getUntransformedPinNumberBox(), recomputeCaches(), and transformBoxForPin().

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), KIGFX::SCH_PAINTER::draw(), SCH_TOOL_BASE< T >::Increment(), and SYMBOL_EDITOR_EDIT_TOOL::ShouldFocusPinNumber().

◆ GetPinNumberInfo()

std::optional< PIN_LAYOUT_CACHE::TEXT_INFO > PIN_LAYOUT_CACHE::GetPinNumberInfo ( int aShadowWidth )

◆ getPinTextOffset()

int PIN_LAYOUT_CACHE::getPinTextOffset ( ) const

private

Get the current pin text offset.

Definition at line 520 of file pin_layout_cache.cpp.

References DEFAULT_TEXT_OFFSET_RATIO, KiROUND(), m_schSettings, and schIUScale.

Referenced by getNumberBlockOffset(), GetPinElectricalTypeInfo(), GetPinNameInfo(), getUntransformedPinNameBox(), and getUntransformedPinNumberBox().

◆ getUntransformedAltIconBox()

OPT_BOX2I PIN_LAYOUT_CACHE::getUntransformedAltIconBox ( ) const

private

Definition at line 632 of file pin_layout_cache.cpp.

References BOX2< VECTOR2I >::ByCenter(), getUntransformedPinNameBox(), m_pin, m_showAltIcons, and schIUScale.

Referenced by GetAltIconBBox(), and GetPinBoundingBox().

◆ getUntransformedDecorationBox()

OPT_BOX2I PIN_LAYOUT_CACHE::getUntransformedDecorationBox ( ) const

private

Pin type decoration if any.

Definition at line 656 of file pin_layout_cache.cpp.

References BOX2< VECTOR2I >::ByCenter(), BOX2< VECTOR2I >::ByCorners(), CLOCK, CLOCK_LOW, externalPinDecoSize(), FALLING_EDGE_CLOCK, INPUT_LOW, internalPinDecoSize(), INVERTED, INVERTED_CLOCK, LINE, m_pin, m_schSettings, and NONLOGIC.

Referenced by GetPinBoundingBox().

◆ getUntransformedPinNameBox()

OPT_BOX2I PIN_LAYOUT_CACHE::getUntransformedPinNameBox ( ) const

private

Get the untransformd text box in the default orientation.

This will have to be offset and rotated.

Definition at line 528 of file pin_layout_cache.cpp.

References BOX2< VECTOR2I >::ByCenter(), getPinTextOffset(), m_nameExtentsCache, m_pin, and BOX2< Vec >::Move().

Referenced by GetPinBoundingBox(), GetPinNameBBox(), and getUntransformedAltIconBox().

◆ getUntransformedPinNumberBox()

OPT_BOX2I PIN_LAYOUT_CACHE::getUntransformedPinNumberBox ( ) const

private

Definition at line 568 of file pin_layout_cache.cpp.

References BOX2< VECTOR2I >::ByCenter(), DefaultTransform, empty(), getPinTextOffset(), m_numExtentsCache, and m_pin.

Referenced by GetPinBoundingBox(), and GetPinNumberBBox().

◆ getUntransformedPinTypeBox()

OPT_BOX2I PIN_LAYOUT_CACHE::getUntransformedPinTypeBox ( ) const

private

Definition at line 615 of file pin_layout_cache.cpp.

References m_showElectricalType, m_typeExtentsCache, PIN_TEXT_MARGIN, schIUScale, and TARGET_PIN_RADIUS.

Referenced by GetPinBoundingBox().

◆ isDirty()

bool PIN_LAYOUT_CACHE::isDirty ( int aMask ) const

inlineprivate

Definition at line 118 of file pin_layout_cache.h.

References m_dirtyFlags.

Referenced by recomputeCaches().

◆ MarkDirty()

void PIN_LAYOUT_CACHE::MarkDirty ( int aFlags )

Recompute all the layout information.

Definition at line 160 of file pin_layout_cache.cpp.

References m_dirtyFlags.

Referenced by SetRenderParameters().

◆ recomputeCaches()

void PIN_LAYOUT_CACHE::recomputeCaches ( )

private

Recompute all the caches that have become dirty.

Definition at line 253 of file pin_layout_cache.cpp.

References EESCHEMA_SETTINGS::APPEARANCE::default_font, ELEC_TYPE, FormatStackedPinForDisplay(), GetAppSettings(), KIFONT::FONT::GetFont(), isDirty(), KIFONT::FONT::IsOutline(), EESCHEMA_SETTINGS::m_Appearance, m_nameExtentsCache, m_numExtentsCache, m_numSource, m_numSourceLength, m_pin, m_shadowOffsetAdjust, m_typeExtentsCache, NAME, name, NUMBER, recomputeExtentsCache(), schIUScale, and setClean().

Referenced by GetPinBoundingBox(), GetPinElectricalTypeInfo(), GetPinNameBBox(), GetPinNameInfo(), GetPinNumberBBox(), and GetPinNumberInfo().

◆ recomputeExtentsCache()

void PIN_LAYOUT_CACHE::recomputeExtentsCache	(	bool	aDefinitelyDirty,
		KIFONT::FONT *	aFont,
		int	aSize,
		const wxString &	aText,
		const KIFONT::METRICS &	aFontMetrics,
		TEXT_EXTENTS_CACHE &	aCache )