54#include <api/common/types/base_types.pb.h>
97 m_IuScale( aIuScale ),
98 m_render_cache_font( nullptr ),
118 m_IuScale( aText.m_IuScale )
135 for(
const std::unique_ptr<KIFONT::GLYPH>& glyph : aText.
m_render_cache )
138 m_render_cache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( *outline ) );
140 m_render_cache.emplace_back( std::make_unique<KIFONT::STROKE_GLYPH>( *stroke ) );
171 for(
const std::unique_ptr<KIFONT::GLYPH>& glyph : aText.
m_render_cache )
174 m_render_cache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( *outline ) );
176 m_render_cache.emplace_back( std::make_unique<KIFONT::STROKE_GLYPH>( *stroke ) );
196 types::TextAttributes* attrs =
text.mutable_attributes();
199 attrs->set_font_name(
GetFont()->GetName().ToStdString() );
201 attrs->set_horizontal_alignment(
202 ToProtoEnum<GR_TEXT_H_ALIGN_T, types::HorizontalAlignment>(
GetHorizJustify() ) );
204 attrs->set_vertical_alignment(
205 ToProtoEnum<GR_TEXT_V_ALIGN_T, types::VerticalAlignment>(
GetVertJustify() ) );
211 attrs->set_bold(
IsBold() );
213 attrs->set_visible(
true );
217 PackVector2( *attrs->mutable_size(),
GetTextSize() );
219 aContainer.PackFrom(
text );
228 if( !aContainer.UnpackTo( &
text ) )
231 SetText( wxString(
text.text().c_str(), wxConvUTF8 ) );
235 if(
text.has_attributes() )
245 attrs.
m_Size = UnpackVector2(
text.attributes().size() );
247 if( !
text.attributes().font_name().empty() )
250 wxString(
text.attributes().font_name().c_str(), wxConvUTF8 ), attrs.
m_Bold,
257 attrs.
m_Halign = FromProtoEnum<GR_TEXT_H_ALIGN_T, types::HorizontalAlignment>(
258 text.attributes().horizontal_alignment() );
260 attrs.
m_Valign = FromProtoEnum<GR_TEXT_V_ALIGN_T, types::VerticalAlignment>(
261 text.attributes().vertical_alignment() );
471 penWidth = aDefaultPenWidth;
475 else if( penWidth <= 1 )
538 aEnforceMinTextSize =
false;
540 if( aEnforceMinTextSize )
545 aNewSize =
VECTOR2I( std::clamp( aNewSize.
x, min, max ),
546 std::clamp( aNewSize.
y, min, max ) );
598 if( aOffset.
x == 0 && aOffset.
y == 0 )
606 outline->Move( aOffset );
608 glyph = stroke->Transform( { 1.0, 1.0 }, aOffset, 0,
ANGLE_0,
false, { 0, 0 } );
675std::vector<std::unique_ptr<KIFONT::GLYPH>>*
724 m_render_cache.emplace_back( std::make_unique<KIFONT::OUTLINE_GLYPH>( aPoly ) );
741 if( cache_it !=
m_bbox_cache.end() && cache_it->second.m_pos == drawPos )
742 return cache_it->second.m_bbox;
745 wxArrayString strings;
753 if( strings.GetCount() )
755 if( aLine >= 0 && ( aLine <
static_cast<int>( strings.GetCount() ) ) )
756 text = strings.Item( aLine );
758 text = strings.Item( 0 );
768 int overbarOffset = 0;
774 int fudgeFactor =
KiROUND( extents.
y * 0.17 );
777 textsize.
y += fudgeFactor;
782 if(
text.Contains( wxT(
"~{" ) ) )
783 overbarOffset = extents.
y / 6;
790 for(
unsigned ii = 1; ii < strings.GetCount(); ii++ )
792 text = strings.Item( ii );
794 textsize.
x = std::max( textsize.
x, extents.
x );
802 textsize.
y += overbarOffset;
830 wxFAIL_MSG( wxT(
"Indeterminate state legal only in dialogs." ) );
837 bbox.
Offset( 0, -fudgeFactor );
846 bbox.
Offset( 0, fudgeFactor );
850 wxFAIL_MSG( wxT(
"Indeterminate state legal only in dialogs." ) );
885 std::vector<VECTOR2I> positions;
886 wxArrayString strings;
889 positions.reserve( strings.Count() );
893 for(
unsigned ii = 0; ii < strings.Count(); ii++ )
904 int aLineCount )
const
921 pos.
y -= ( aLineCount - 1 ) * offset.
y / 2;
925 pos.
y -= ( aLineCount - 1 ) * offset.
y;
929 wxFAIL_MSG( wxT(
"Indeterminate state legal only in dialogs." ) );
940 for(
int ii = 0; ii < aLineCount; ii++ )
942 aPositions.push_back( (
VECTOR2I) pos );
976 wxString stylemsg[4] = {
983 return stylemsg[style];
992 return wxEmptyString;
999 return font->GetName();
1002 return _(
"Default Font" );
1012 if( aFontName ==
_(
"Default Font" ) )
1043 aFormatter->
Print(
"(effects" );
1045 aFormatter->
Print(
"(font" );
1048 aFormatter->
Print(
"(face %s)", aFormatter->
Quotew(
GetFont()->NameAsToken() ).c_str() );
1051 aFormatter->
Print(
"(size %s %s)",
1057 aFormatter->
Print(
"(line_spacing %s)",
1063 aFormatter->
Print(
"(thickness %s)",
1075 aFormatter->
Print(
"(color %d %d %d %s)",
1082 aFormatter->
Print(
")");
1087 aFormatter->
Print(
"(justify");
1096 aFormatter->
Print(
" mirror" );
1098 aFormatter->
Print(
")" );
1104 aFormatter->
Print(
")" );
1112 std::shared_ptr<SHAPE_COMPOUND> shape = std::make_shared<SHAPE_COMPOUND>();
1120 std::vector<std::unique_ptr<KIFONT::GLYPH>>* cache =
nullptr;
1144 shape->AddShape(
new SHAPE_SEGMENT( aPt1, aPt2, penWidth ) );
1151 for(
const VECTOR2I& point : { aPt1, aPt2, aPt3 } )
1152 triShape->
Append( point.x, point.y );
1154 shape->AddShape( triShape );
1169 shape->AddShape(
new SHAPE_SEGMENT( aPt1, aPt2, penWidth ) );
1174 shape->AddShape( aPoly.Clone() );
1189 wxCHECK( aOther, 1 );
1218 return( uri.Create( aURL ) && uri.HasScheme() );
1224 const wxString& str1 =
GetText();
1225 const wxString& str2 = aOther.
GetText();
1227 int m = str1.length();
1228 int n = str2.length();
1230 if( n == 0 || m == 0 )
1234 std::vector<std::vector<int>>
distance(m + 1, std::vector<int>(n + 1));
1237 for(
int i = 0; i <= m; i++ )
1239 for(
int j = 0; j <= n; j++ )
1243 for(
int i = 1; i <= m; i++ )
1245 for(
int j = 1; j <= n; j++ )
1247 if( str1[i - 1] == str2[j - 1] )
1260 int maxLen = std::max( m, n );
1261 double similarity = 1.0 - (
static_cast<double>(
distance[m][n] ) / maxLen );
1269 double retval = 1.0;
1285 return aHref.StartsWith( wxT(
"#" ), aDestination );
1291 return wxT(
"#" ) + aDestination;
1312 if( h_inst.Choices().GetCount() == 0)
1321 if( v_inst.Choices().GetCount() == 0)
1333 PROPERTY_DISPLAY::PT_DEGREE ) );
1335 const wxString textProps =
_HKI(
"Text Properties" );
1349 std::vector<std::string> fontNames;
1352 std::string(
Pgm().GetLanguageTag().utf8_str() ),
1356 fonts.Add(
_(
"Default Font" ) );
1360 for(
const std::string& fontName : fontNames )
1361 fonts.Add( wxString( fontName ) );
1371 PROPERTY_DISPLAY::PT_SIZE ),
1400 PROPERTY_DISPLAY::PT_SIZE ),
1405 PROPERTY_DISPLAY::PT_SIZE ),
1409 _HKI(
"Horizontal Justification" ),
1413 _HKI(
"Vertical Justification" ),
constexpr EDA_IU_SCALE unityScale
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
constexpr void SetOrigin(const Vec &pos)
constexpr BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
constexpr coord_type GetY() const
constexpr size_type GetWidth() const
constexpr coord_type GetX() const
constexpr const Vec GetCenter() const
constexpr void SetSize(const SizeVec &size)
constexpr size_type GetHeight() const
constexpr bool Contains(const Vec &aPoint) const
constexpr void SetX(coord_type val)
constexpr BOX2< Vec > GetInflated(coord_type aDx, coord_type aDy) const
Get a new rectangle that is this one, inflated by aDx and aDy.
constexpr void SetY(coord_type val)
constexpr void Offset(coord_type dx, coord_type dy)
constexpr bool Intersects(const BOX2< Vec > &aRect) const
A base class for most all the KiCad significant classes used in schematics and boards.
KICAD_T Type() const
Returns the type of object.
virtual const std::vector< wxString > * GetEmbeddedFonts()
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 supp...
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
int GetTextHeight() const
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
void SetTextColor(const COLOR4D &aColor)
const VECTOR2I & GetTextPos() const
COLOR4D GetTextColor() const
wxString GetTextStyleName() const
std::map< int, BBOX_CACHE_ENTRY > m_bbox_cache
bool IsDefaultFormatting() const
static bool IsGotoPageHref(const wxString &aHref, wxString *aDestination=nullptr)
Check if aHref is a valid internal hyperlink.
void SetFontProp(const wxString &aFontName)
std::vector< std::unique_ptr< KIFONT::GLYPH > > m_render_cache
wxString GetFontName() const
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
bool IsMultilineAllowed() const
virtual const wxString & GetText() const
Return the string associated with the text object.
bool IsKeepUpright() const
virtual bool IsVisible() const
void SetTextPos(const VECTOR2I &aPoint)
bool m_shown_text_has_text_var_refs
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
KIFONT::FONT * GetFont() const
bool ResolveFont(const std::vector< wxString > *aEmbeddedFonts)
void SetAttributes(const EDA_TEXT &aSrc, bool aSetPosition=true)
Set the text attributes from another instance.
void SetMirrored(bool isMirrored)
wxString GetFontProp() const
std::vector< std::unique_ptr< KIFONT::GLYPH > > * GetRenderCache(const KIFONT::FONT *aFont, const wxString &forResolvedText, const VECTOR2I &aOffset={ 0, 0 }) const
const KIFONT::FONT * m_render_cache_font
virtual EDA_ANGLE GetDrawRotation() const
wxString m_unresolvedFontName
virtual VECTOR2I GetDrawPos() const
EDA_TEXT & operator=(const EDA_TEXT &aItem)
BOX2I GetTextBox(const RENDER_SETTINGS *aSettings, int aLine=-1) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
virtual bool HasHyperlink() const
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
wxString GetHyperlink() const
void Offset(const VECTOR2I &aOffset)
virtual void Format(OUTPUTFORMATTER *aFormatter, int aControlBits) const
Output the object to aFormatter in s-expression form.
GR_TEXT_H_ALIGN_T GetHorizJustify() const
void SetTextWidth(int aWidth)
virtual KIFONT::FONT * GetDrawFont(const RENDER_SETTINGS *aSettings) const
void SetBoldFlag(bool aBold)
Set only the bold flag, without changing the font.
bool Replace(const EDA_SEARCH_DATA &aSearchData)
Helper function used in search and replace dialog.
void SetupRenderCache(const wxString &aResolvedText, const KIFONT::FONT *aFont, const EDA_ANGLE &aAngle, const VECTOR2I &aOffset)
int Compare(const EDA_TEXT *aOther) const
std::reference_wrapper< const EDA_IU_SCALE > m_IuScale
virtual void SetVisible(bool aVisible)
EDA_TEXT(const EDA_IU_SCALE &aIuScale, const wxString &aText=wxEmptyString)
static wxString GotoPageHref(const wxString &aDestination)
Generate a href to a page in the current schematic.
virtual void ClearBoundingBoxCache()
bool GetAutoThickness() const
double GetLineSpacing() const
double Similarity(const EDA_TEXT &aOther) const
VECTOR2I m_render_cache_offset
void SetLineSpacing(double aLineSpacing)
void AddRenderCacheGlyph(const SHAPE_POLY_SET &aPoly)
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
virtual bool TextHitTest(const VECTOR2I &aPoint, int aAccuracy=0) const
Test if aPoint is within the bounds of this object.
void SetTextHeight(int aHeight)
virtual void cacheShownText()
EDA_ANGLE m_render_cache_angle
static GR_TEXT_H_ALIGN_T MapHorizJustify(int aHorizJustify)
virtual void ClearRenderCache()
const TEXT_ATTRIBUTES & GetAttributes() const
void SetBold(bool aBold)
Set the text to be bold - this will also update the font if needed.
static bool ValidateHyperlink(const wxString &aURL)
Check if aURL is a valid hyperlink.
void SetItalicFlag(bool aItalic)
Set only the italic flag, without changing the font.
void SetAutoThickness(bool aAuto)
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
void SwapAttributes(EDA_TEXT &aTradingPartner)
Swap the text attributes of the two involved instances.
wxString m_render_cache_text
void Print(const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor)
Print this text object to the device context aDC.
double GetTextAngleDegrees() const
void GetLinePositions(const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPositions, int aLineCount) const
Populate aPositions with the position of each line of a multiline text, according to the vertical jus...
virtual const KIFONT::METRICS & getFontMetrics() const
std::shared_ptr< SHAPE_COMPOUND > GetEffectiveTextShape(bool aTriangulate=true, const BOX2I &aBBox=BOX2I(), const EDA_ANGLE &aAngle=ANGLE_0) const
build a list of segments (SHAPE_SEGMENT) to describe a text shape.
void SetTextAngleDegrees(double aOrientation)
void SetHyperlink(wxString aLink)
static GR_TEXT_V_ALIGN_T MapVertJustify(int aVertJustify)
void SetKeepUpright(bool aKeepUpright)
void CopyText(const EDA_TEXT &aSrc)
GR_TEXT_V_ALIGN_T GetVertJustify() const
int GetInterline(const RENDER_SETTINGS *aSettings) const
Return the distance between two lines of text.
int GetTextThicknessProperty() const
virtual wxString GetShownText(bool aAllowExtraText, int aDepth=0) const
Return the string actually shown after processing of the base text.
virtual void SetText(const wxString &aText)
double Levenshtein(const EDA_TEXT &aOther) const
Return the levenstein distance between two texts.
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
int GetTextThickness() const
void SetItalic(bool aItalic)
Set the text to be italic - this will also update the font if needed.
void SwapText(EDA_TEXT &aTradingPartner)
void SetMultilineAllowed(bool aAllow)
void SetFont(KIFONT::FONT *aFont)
void printOneLineOfText(const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor, const wxString &aText, const VECTOR2I &aPos)
Print each line of this EDA_TEXT.
VECTOR2I GetTextSize() const
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
TEXT_ATTRIBUTES m_attributes
static ENUM_MAP< T > & Instance()
Class that other classes need to inherit from, in order to be inspectable.
FONT is an abstract base class for both outline and stroke fonts.
static FONT * GetFont(const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false, const std::vector< wxString > *aEmbeddedFiles=nullptr, bool aForDrawingSheet=false)
virtual bool IsStroke() const
void Draw(KIGFX::GAL *aGal, const wxString &aText, const VECTOR2I &aPosition, const VECTOR2I &aCursor, const TEXT_ATTRIBUTES &aAttributes, const METRICS &aFontMetrics) const
Draw a string.
const wxString & GetName() const
virtual bool IsOutline() const
VECTOR2I StringBoundaryLimits(const wxString &aText, const VECTOR2I &aSize, int aThickness, bool aBold, bool aItalic, const METRICS &aFontMetrics) const
Compute the boundary limits of aText (the bounding box of all shapes).
virtual double GetInterline(double aGlyphHeight, const METRICS &aFontMetrics) const =0
Compute the distance (interline) between 2 lines of text (for multiline texts).
static const METRICS & Default()
Class OUTLINE_FONT implements outline font drawing.
void GetLinesAsGlyphs(std::vector< std::unique_ptr< GLYPH > > *aGlyphs, const wxString &aText, const VECTOR2I &aPosition, const TEXT_ATTRIBUTES &aAttrs, const METRICS &aFontMetrics) const
A color representation with 4 components: red, green, blue, alpha.
virtual void DrawGlyphs(const std::vector< std::unique_ptr< KIFONT::GLYPH > > &aGlyphs)
Draw polygons representing font glyphs.
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
int GetDefaultPenWidth() const
const wxString & GetDefaultFont() const
wxDC * GetPrintDC() const
PROPERTY_BASE & SetChoicesFunc(std::function< wxPGChoices(INSPECTABLE *)> aFunc)
PROPERTY_BASE & SetAvailableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Set a callback function to determine whether an object provides this property.
PROPERTY_BASE & SetIsHiddenFromRulesEditor(bool aHide=true)
Provide class metadata.Helper macro to map type hashes to names.
static PROPERTY_MANAGER & Instance()
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Represent a set of closed polygons.
Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments.
void Append(int aX, int aY)
Append a new point at the end of the polygon.
int Compare(const TEXT_ATTRIBUTES &aRhs) const
GR_TEXT_H_ALIGN_T m_Halign
GR_TEXT_V_ALIGN_T m_Valign
#define CTL_OMIT_HYPERLINK
Omit the hyperlink attribute in .kicad_xxx files.
#define CTL_OMIT_COLOR
Omit the color attribute in .kicad_xxx files.
static constexpr EDA_ANGLE ANGLE_0
std::ostream & operator<<(std::ostream &aStream, const EDA_TEXT &aText)
static struct EDA_TEXT_DESC _EDA_TEXT_DESC
#define TEXT_MIN_SIZE_MM
Minimum text size (1 micron).
#define TEXT_MAX_SIZE_MM
Maximum text size in mm (~10 inches)
#define DEFAULT_SIZE_TEXT
This is the "default-of-the-default" hardcoded text size; individual application define their own def...
static constexpr double ITALIC_TILT
Tilt factor for italic style (this is the scaling factor on dY relative coordinates to give a tilted ...
FONTCONFIG * Fontconfig()
int GetPenSizeForBold(int aTextSize)
int GetPenSizeForNormal(int aTextSize)
void GRPrintText(wxDC *aDC, const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const EDA_ANGLE &aOrient, const VECTOR2I &aSize, enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify, int aWidth, bool aItalic, bool aBold, KIFONT::FONT *aFont, const KIFONT::METRICS &aFontMetrics)
Print a graphic text through wxDC.
int ClampTextPenSize(int aPenSize, int aSize, bool aStrict)
Pen width should not allow characters to become cluttered up in their own fatness.
Some functions to handle hotkeys in KiCad.
constexpr int Mils2IU(const EDA_IU_SCALE &aIuScale, int mils)
KICOMMON_API std::string FormatInternalUnits(const EDA_IU_SCALE &aIuScale, int aValue)
Converts aValue from internal units to a string appropriate for writing to file.
PGM_BASE & Pgm()
The global program "get" accessor.
#define ENUM_TO_WXANY(type)
Macro to define read-only fields (no setter method available)
static float distance(const SFVEC2UI &a, const SFVEC2UI &b)
wxString UnescapeString(const wxString &aSource)
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
std::string FormatDouble2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 This function is intended in...
GR_TEXT_H_ALIGN_T
This is API surface mapped to common.types.HorizontalAlignment.
@ GR_TEXT_H_ALIGN_INDETERMINATE
GR_TEXT_V_ALIGN_T
This is API surface mapped to common.types.VertialAlignment.
@ GR_TEXT_V_ALIGN_INDETERMINATE
VECTOR2I GetRotated(const VECTOR2I &aVector, const EDA_ANGLE &aAngle)
Return a new VECTOR2I that is the result of rotating aVector by aAngle.
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
constexpr bool IsEeschemaType(const KICAD_T aType)
VECTOR2< int32_t > VECTOR2I