gr_text.h File Reference

#include <eda_item.h>
#include <eda_text.h>

Go to the source code of this file.

Macros
#define	MIN_TEXT_SIZE   5
	Minimum dimension in pixel for drawing/no drawing a text used in Pcbnew to decide to draw (or not) some texts ( like net names on pads/tracks ). More...
#define	MIN_DRAWABLE_TEXT_SIZE   3

Functions
int	Clamp_Text_PenSize (int aPenSize, int aSize, bool aBold=true)
	As a rule, pen width should not be >1/4em, otherwise the character will be cluttered up in its own fatness. More...
float	Clamp_Text_PenSize (float aPenSize, int aSize, bool aBold=true)
int	Clamp_Text_PenSize (int aPenSize, wxSize aSize, bool aBold=true)
int	GetPenSizeForBold (int aTextSize)
	Function GetPensizeForBold. More...
int	GetPenSizeForNormal (int aTextSize)
int	GraphicTextWidth (const wxString &aText, const wxSize &aSize, bool italic, bool bold)
	The full X size is GraphicTextWidth + the thickness of graphic lines. More...
void	GRText (wxDC *aDC, const wxPoint &aPos, COLOR4D aColor, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData)=nullptr, void *aCallbackData=nullptr, PLOTTER *aPlotter=nullptr)
	Draw a graphic text (like footprint text) More...
void	GRHaloText (wxDC *aDC, const wxPoint &aPos, COLOR4D aBgColor, COLOR4D aColor1, COLOR4D aColor2, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf, void *aData)=nullptr, void *aCallbackData=nullptr, PLOTTER *aPlotter=nullptr)
	Draw graphic text with a border so that it can be read on different backgrounds. More...

Macro Definition Documentation

MIN_DRAWABLE_TEXT_SIZE

#define MIN_DRAWABLE_TEXT_SIZE   3

Definition at line 49 of file gr_text.h.

MIN_TEXT_SIZE

#define MIN_TEXT_SIZE   5

Minimum dimension in pixel for drawing/no drawing a text used in Pcbnew to decide to draw (or not) some texts ( like net names on pads/tracks ).

When a text height is smaller than MIN_TEXT_SIZE, it is not drawn by Pcbnew.

Definition at line 43 of file gr_text.h.

Function Documentation

Clamp_Text_PenSize() [1/3]

int Clamp_Text_PenSize	(	int	aPenSize,
		int	aSize,
		bool	aBold
	)

As a rule, pen width should not be >1/4em, otherwise the character will be cluttered up in its own fatness.

The pen width max is aSize/4 for bold texts, and aSize/6 for normal texts. The "best" pen width is aSize/5 for bold texts so the clamp is consistent with bold option.

Parameters

aPenSize	the pen size to clamp.
aSize	the char size (height or width, or its wxSize).
aBold	true if text accept bold pen size.

Returns

the max pen size allowed.

As a rule, pen width should not be >1/4em, otherwise the character will be cluttered up in its own fatness.

Bold fonts are generally around aSize/5 in width, so we limit them to aSize/4, and normal text to aSize/6.

Parameters

aPenSize	= the pen size to clamp
aSize	the char size (height or width)
aBold	= true if text accept bold pen size

Returns

the max pen size allowed

Definition at line 69 of file gr_text.cpp.

{
    double scale    = aBold ? 4.0 : 6.0;
    int    maxWidth = KiROUND( (double) aSize / scale );

    return std::min( aPenSize, maxWidth );
}

References KiROUND(), and scale.

Referenced by Clamp_Text_PenSize(), KIGFX::SCH_PAINTER::draw(), EDA_TEXT::GetEffectiveTextPenWidth(), LIB_PIN::PlotPinTexts(), LIB_PIN::printPinTexts(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

Clamp_Text_PenSize() [2/3]

float Clamp_Text_PenSize	(	float	aPenSize,
		int	aSize,
		bool	aBold = true
	)

Definition at line 78 of file gr_text.cpp.

{
    float scale    = aBold ? 4.0 : 6.0;
    float maxWidth = (float) aSize / scale;

    return std::min( aPenSize, maxWidth );
}

References scale.

Clamp_Text_PenSize() [3/3]

int Clamp_Text_PenSize	(	int	aPenSize,
		wxSize	aSize,
		bool	aBold = true
	)

Definition at line 87 of file gr_text.cpp.

{
    int size = std::min( std::abs( aSize.x ), std::abs( aSize.y ) );

    return Clamp_Text_PenSize( aPenSize, size, aBold );
}

References Clamp_Text_PenSize().

GetPenSizeForBold()

int GetPenSizeForBold

(

int

aTextSize

)

Function GetPensizeForBold.

Parameters

aTextSize

the char size (height or width).

Returns

the "best" value for a pen size to draw/plot a bold text.

the "best" value for a pen size to draw/plot a bold text

Parameters

aTextSize

= the char size (height or width)

Definition at line 48 of file gr_text.cpp.

{
    return KiROUND( aTextSize / 5.0 );
}

References KiROUND().

Referenced by EDA_TEXT::GetEffectiveTextPenWidth(), GRText(), SCH_LEGACY_PLUGIN::loadText(), SCH_EAGLE_PLUGIN::loadTextAttributes(), WS_DATA_ITEM_TEXT::SyncDrawItems(), and DIALOG_LABEL_EDITOR::TransferDataFromWindow().

GetPenSizeForNormal()

int GetPenSizeForNormal

(

int

aTextSize

)

Parameters

aTextSize

= the char size (height or width).

Returns

the "best" value for a pen size to draw/plot a non-bold text.

Definition at line 54 of file gr_text.cpp.

{
    return KiROUND( aTextSize / 8.0 );
}

References KiROUND().

Referenced by EDA_TEXT::GetEffectiveTextPenWidth().

GraphicTextWidth()

int GraphicTextWidth	(	const wxString &	aText,
		const wxSize &	aSize,
		bool	italic,
		bool	bold
	)

The full X size is GraphicTextWidth + the thickness of graphic lines.

Returns

the X size of the graphic text.

Definition at line 95 of file gr_text.cpp.

{
    basic_gal.SetFontItalic( aItalic );
    basic_gal.SetFontBold( aBold );
    basic_gal.SetGlyphSize( VECTOR2D( aSize ) );

    VECTOR2D tsize = basic_gal.GetTextLineSize( aText );

    return KiROUND( tsize.x );
}

References basic_gal, KIGFX::GAL::GetTextLineSize(), KiROUND(), KIGFX::GAL::SetFontBold(), KIGFX::GAL::SetFontItalic(), KIGFX::GAL::SetGlyphSize(), and VECTOR2< T >::x.

Referenced by SVG_PLOTTER::Text().

GRHaloText()

void GRHaloText	(	wxDC *	aDC,
		const wxPoint &	aPos,
		COLOR4D	aBgColor,
		COLOR4D	aColor1,
		COLOR4D	aColor2,
		const wxString &	aText,
		double	aOrient,
		const wxSize &	aSize,
		enum EDA_TEXT_HJUSTIFY_T	aH_justify,
		enum EDA_TEXT_VJUSTIFY_T	aV_justify,
		int	aWidth,
		bool	aItalic,
		bool	aBold,
		void(*)(int x0, int y0, int xf, int yf, void *aData)	aCallback = nullptr,
		void *	aCallbackData = nullptr,
		PLOTTER *	aPlotter = nullptr
	)

Draw graphic text with a border so that it can be read on different backgrounds.

See GRText for most of the parameters. If aBgColor is a dark color text is drawn in aColor2 with aColor1 border. Otherwise colors are swapped.

Definition at line 176 of file gr_text.cpp.

{
    // Swap color if contrast would be better
    // TODO: Maybe calculate contrast some way other than brightness
    if( aBgColor.GetBrightness() > 0.5 )
    {
        COLOR4D c = aColor1;
        aColor1 = aColor2;
        aColor2 = c;
    }

    // Draw the background
    GRText( aDC, aPos, aColor1, aText, aOrient, aSize, aH_justify, aV_justify, aWidth, aItalic,
            aBold, aCallback, aCallbackData, aPlotter );

    // Draw the text
    GRText( aDC, aPos, aColor2, aText, aOrient, aSize, aH_justify, aV_justify, aWidth/4, aItalic,
            aBold, aCallback, aCallbackData, aPlotter );
}

References KIGFX::COLOR4D::GetBrightness(), and GRText().

GRText()

void GRText	(	wxDC *	aDC,
		const wxPoint &	aPos,
		COLOR4D	aColor,
		const wxString &	aText,
		double	aOrient,
		const wxSize &	aSize,
		enum EDA_TEXT_HJUSTIFY_T	aH_justify,
		enum EDA_TEXT_VJUSTIFY_T	aV_justify,
		int	aWidth,
		bool	aItalic,
		bool	aBold,
		void(*)(int x0, int y0, int xf, int yf, void *aData)	aCallback,
		void *	aCallbackData,
		PLOTTER *	aPlotter
	)

Draw a graphic text (like footprint text)

Parameters

aClipBox	the clipping rect, or NULL if no clipping.
aDC	the current Device Context. NULL if draw within a 3D GL Canvas.
aPos	text position (according to h_justify, v_justify).
aColor	(COLOR4D) = text color.
aText	text to draw.
aOrient	angle in 0.1 degree.
aSize	text size (size.x or size.y can be < 0 for mirrored texts).
aH_justify	horizontal justification (Left, center, right).
aV_justify	vertical justification (bottom, center, top).
aWidth	line width (pen width) (default = 0). If width < 0 : draw segments in sketch mode, width = abs(width). Use a value min(aSize.x, aSize.y) / 5 for a bold text.
aItalic	true to simulate an italic font.
aBold	true to use a bold font.
aCallback	( int x0, int y0, int xf, int yf, void* aData ) is a function called (if non null) to draw each segment. used to draw 3D texts or for plotting. NULL for normal drawings.
aCallbackData	is the auxiliary parameter aData for the callback function. This can be nullptr if no auxiliary parameter is needed.
aPlotter	= a pointer to a PLOTTER instance, when this function is used to plot the text. NULL to draw this text.

Draw a graphic text (like footprint text)

Parameters

aDC	= the current Device Context. NULL if draw within a 3D GL Canvas
aPos	= text position (according to h_justify, v_justify)
aColor	(COLOR4D) = text color
aText	= text to draw
aOrient	= angle in 0.1 degree
aSize	= text size (size.x or size.y can be < 0 for mirrored texts)
aH_justify	= horizontal justification (Left, center, right)
aV_justify	= vertical justification (bottom, center, top)
aWidth	= line width (pen width) (use default width if aWidth = 0) if width < 0 : draw segments in sketch mode, width = abs(width) Use a value min(aSize.x, aSize.y) / 5 for a bold text
aItalic	= true to simulate an italic font
aBold	= true to use a bold font. Useful only with default width value (aWidth = 0)
aCallback(	int x0, int y0, int xf, int yf, void* aData ) is a function called (if non null) to draw each segment. used to draw 3D texts or for plotting. NULL for normal drawings
aCallbackData	= is the auxiliary parameter aData for the callback function. can be nullptr if no auxiliary parameter is needed
aPlotter	= a pointer to a PLOTTER instance, when this function is used to plot the text. NULL to draw this text.

Definition at line 131 of file gr_text.cpp.

{
    bool fill_mode = true;

    if( aWidth == 0 && aBold ) // Use default values if aWidth == 0
        aWidth = GetPenSizeForBold( std::min( aSize.x, aSize.y ) );

    if( aWidth < 0 )
    {
        aWidth = -aWidth;
        fill_mode = false;
    }

    basic_gal.SetIsFill( fill_mode );
    basic_gal.SetLineWidth( aWidth );

    EDA_TEXT dummy;
    dummy.SetItalic( aItalic );
    dummy.SetBold( aBold );
    dummy.SetHorizJustify( aH_justify );
    dummy.SetVertJustify( aV_justify );

    wxSize size = aSize;
    dummy.SetMirrored( size.x < 0 );

    if( size.x < 0 )
        size.x = - size.x;

    dummy.SetTextSize( size );

    basic_gal.SetTextAttributes( &dummy );
    basic_gal.SetPlotter( aPlotter );
    basic_gal.SetCallback( aCallback, aCallbackData );
    basic_gal.m_DC = aDC;
    basic_gal.m_Color = aColor;
    basic_gal.SetClipBox( nullptr );

    basic_gal.StrokeText( aText, VECTOR2D( aPos ), aOrient * M_PI/1800 );
}

References basic_gal, dummy(), GetPenSizeForBold(), BASIC_GAL::m_Color, BASIC_GAL::m_DC, BASIC_GAL::SetCallback(), BASIC_GAL::SetClipBox(), KIGFX::GAL::SetIsFill(), KIGFX::GAL::SetLineWidth(), BASIC_GAL::SetPlotter(), KIGFX::GAL::SetTextAttributes(), and KIGFX::GAL::StrokeText().

Referenced by BOARD_ADAPTER::addFootprintShapesWithClearance(), BOARD_ADAPTER::addShapeWithClearance(), export_vrml_fp_text(), export_vrml_pcbtext(), GRHaloText(), LIB_TEXT::print(), LIB_FIELD::print(), SCH_FIELD::Print(), EDA_TEXT::printOneLineOfText(), LIB_PIN::printPinElectricalTypeName(), LIB_PIN::printPinTexts(), PLOTTER::Text(), PCB_TEXT::TransformTextShapeWithClearanceToPolygon(), FP_TEXT::TransformTextShapeWithClearanceToPolygon(), and EDA_TEXT::TransformToSegmentList().