KIGFX::PREVIEW Namespace Reference

Classes
class	ARC_ASSISTANT
	Represents an assistant draw when interactively drawing an arc on a canvas. More...
class	ARC_GEOM_MANAGER
	Manage the construction of a circular arc though sequential setting of critical points: center, arc start and arc end. More...
class	CENTRELINE_RECT_ITEM
	Represent an area drawn by drawing a rectangle of a given aspect along a vector, with the midpoint of one side on the start point and the mid point of the opposite side on the end. More...
class	DRAW_CONTEXT
	A KIGFX::PREVIEW::DRAW_CONTEXT is a wrapper around a GAL and some other settings that makes it easy to draw preview items consistently. More...
class	MULTISTEP_GEOM_MANAGER
	A geometry manager that works by accepting a sequence of points and advancing though stages of geometric construction with each point "locked in". More...
class	POLYGON_ITEM
	A preview item which shows an in-progress polygon, which can be used for zone outlines, etc. More...
class	RULER_ITEM
	A drawn ruler item for showing the distance between two points. More...
class	SELECTION_AREA
	Represent a selection area (currently a rectangle) in a VIEW, drawn corner-to-corner between two points. More...
class	SIMPLE_OVERLAY_ITEM
	SIMPLE_OVERLAY_ITEM is class that represents a visual area drawn on a canvas, used to temporarily demarcate an area or show something on an overlay. More...
struct	TEXT_DIMS
class	TWO_POINT_ASSISTANT
	Represents an assistant draw when interactively drawing a line or circle on a canvas. More...
class	TWO_POINT_GEOMETRY_MANAGER
	Represent a very simple geometry manager for items that have a start and end point. More...

Enumerations
enum class	GEOM_SHAPE {   SEGMENT = 0 , RECT , ARC , CIRCLE ,   POLYGON , CURVE }

Functions
double	PreviewOverlayDeemphAlpha (bool aDeemph=true)
	Default alpha of "de-emphasised" features (like previously locked-in lines. More...
wxString	DimensionLabel (const wxString &prefix, double aVal, const EDA_IU_SCALE &aIuScale, EDA_UNITS aUnits, bool aIncludeUnits=true)
	Get a formatted string showing a dimension to a sane precision with an optional prefix and unit suffix. More...
TEXT_DIMS	GetConstantGlyphHeight (KIGFX::GAL *aGal, int aRelativeSize=0)
	Set the GAL glyph height to a constant scaled value, so that it always looks the same on screen. More...
COLOR4D	GetShadowColor (const COLOR4D &aColor)
void	DrawTextNextToCursor (KIGFX::VIEW *aView, const VECTOR2D &aCursorPos, const VECTOR2D &aTextQuadrant, const std::vector< wxString > &aStrings, bool aDrawingDropShadows)
	Draw strings next to the cursor. More...

Enumeration Type Documentation

GEOM_SHAPE

enum class KIGFX::PREVIEW::GEOM_SHAPE

strong

Enumerator
SEGMENT
RECT
ARC
CIRCLE
POLYGON
CURVE

Definition at line 37 of file two_point_assistant.h.

{
 SEGMENT = 0,
 RECT,
 ARC,
 CIRCLE,
 POLYGON,
 CURVE
};

Function Documentation

DimensionLabel()

wxString KIGFX::PREVIEW::DimensionLabel	(	const wxString &	prefix,
		double	aVal,
		const EDA_IU_SCALE &	aIuScale,
		EDA_UNITS	aUnits,
		bool	aIncludeUnits = true
	)

Get a formatted string showing a dimension to a sane precision with an optional prefix and unit suffix.

Definition at line 33 of file preview_utils.cpp.

{
 wxString str;
 
 if( prefix.size() )
 str << prefix << ": ";
 
 wxString fmtStr;
 
 // show a sane precision for the preview, which doesn't need to be accurate down to the
 // nanometre
 switch( aUnits )
 {
 case EDA_UNITS::MILLIMETRES: fmtStr = wxT( "%.3f" ); break; // 1um
 case EDA_UNITS::MILS: fmtStr = wxT( "%.1f" ); break; // 0.1mil
 case EDA_UNITS::INCHES: fmtStr = wxT( "%.4f" ); break; // 0.1mil
 case EDA_UNITS::DEGREES: fmtStr = wxT( "%.1f" ); break; // 0.1deg
 case EDA_UNITS::PERCENT: fmtStr = wxT( "%.1f" ); break; // 0.1%
 case EDA_UNITS::UNSCALED: fmtStr = wxT( "%f" ); break;
 }
 
 str << wxString::Format( fmtStr, EDA_UNIT_UTILS::UI::ToUserUnit( aIuScale, aUnits, aVal ) );
 
 if( aIncludeUnits )
 str << EDA_UNIT_UTILS::GetText( aUnits );
 
 return str;
}

References DEGREES, Format(), EDA_UNIT_UTILS::GetText(), INCHES, MILLIMETRES, MILS, PERCENT, EDA_UNIT_UTILS::UI::ToUserUnit(), and UNSCALED.

Referenced by drawCursorStrings(), drawTicksAlongLine(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), and KIGFX::PREVIEW::TWO_POINT_ASSISTANT::ViewDraw().

DrawTextNextToCursor()

void KIGFX::PREVIEW::DrawTextNextToCursor	(	KIGFX::VIEW *	aView,
		const VECTOR2D &	aCursorPos,
		const VECTOR2D &	aTextQuadrant,
		const std::vector< wxString > &	aStrings,
		bool	aDrawingDropShadows
	)

Draw strings next to the cursor.

Parameters

aGal	the GAL to draw on.
aCursorPos	the position of the cursor to draw next to.
aTextQuadrant	a vector pointing to the quadrant to draw the text in.
aStrings	list of strings to draw, top to bottom.

Definition at line 116 of file preview_utils.cpp.

{
 KIGFX::GAL* gal = aView->GetGAL();
 KIFONT::FONT* font = KIFONT::FONT::GetFont();
 
 // constant text size on screen
 TEXT_DIMS textDims = GetConstantGlyphHeight( gal );
 TEXT_ATTRIBUTES textAttrs;
 
 // radius string goes on the right of the cursor centre line with a small horizontal
 // offset (enough to keep clear of a system cursor if present)
 VECTOR2D textPos = aCursorPos;
 
 bool viewFlipped = gal->IsFlippedX();
 
 // if the text goes above the cursor, shift it up
 if( aTextQuadrant.y > 0 )
 textPos.y -= textDims.LinePitch * ( aStrings.size() + 1 );
 
 if( aTextQuadrant.x < 0 )
 {
 if( viewFlipped )
 textAttrs.m_Halign = GR_TEXT_H_ALIGN_RIGHT;
  else
 textAttrs.m_Halign = GR_TEXT_H_ALIGN_LEFT;
 
 textPos.x += 15.0 / gal->GetWorldScale();
 }
 else
 {
 if( viewFlipped )
 textAttrs.m_Halign = GR_TEXT_H_ALIGN_LEFT;
 else
 textAttrs.m_Halign = GR_TEXT_H_ALIGN_RIGHT;
 
 textPos.x -= 15.0 / gal->GetWorldScale();
 }
 
 gal->SetStrokeColor( aView->GetPainter()->GetSettings()->GetLayerColor( LAYER_AUX_ITEMS ) );
 textAttrs.m_Mirrored = viewFlipped; // Prevent text flipping when view is flipped
 textAttrs.m_Size = textDims.GlyphSize;
 textAttrs.m_StrokeWidth = textDims.StrokeWidth;
 gal->SetIsFill( false );
 gal->SetIsStroke( true );
 
 if( aDrawingDropShadows )
 {
 textAttrs.m_StrokeWidth = textDims.StrokeWidth + ( 2 * textDims.ShadowWidth );
 gal->SetStrokeColor( GetShadowColor( gal->GetStrokeColor() ) );
 }
 
 // write strings top-to-bottom
 for( const wxString& str : aStrings )
 {
 textPos.y += textDims.LinePitch;
 font->Draw( gal, str, textPos, textAttrs );
 }
}

References KIFONT::FONT::Draw(), GetConstantGlyphHeight(), KIFONT::FONT::GetFont(), KIGFX::VIEW::GetGAL(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::VIEW::GetPainter(), KIGFX::PAINTER::GetSettings(), GetShadowColor(), KIGFX::GAL::GetStrokeColor(), KIGFX::GAL::GetWorldScale(), KIGFX::PREVIEW::TEXT_DIMS::GlyphSize, GR_TEXT_H_ALIGN_LEFT, GR_TEXT_H_ALIGN_RIGHT, KIGFX::GAL::IsFlippedX(), LAYER_AUX_ITEMS, KIGFX::PREVIEW::TEXT_DIMS::LinePitch, TEXT_ATTRIBUTES::m_Halign, TEXT_ATTRIBUTES::m_Mirrored, TEXT_ATTRIBUTES::m_Size, TEXT_ATTRIBUTES::m_StrokeWidth, KIGFX::GAL::SetIsFill(), KIGFX::GAL::SetIsStroke(), KIGFX::GAL::SetStrokeColor(), KIGFX::PREVIEW::TEXT_DIMS::ShadowWidth, KIGFX::PREVIEW::TEXT_DIMS::StrokeWidth, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by drawCursorStrings(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), and KIGFX::PREVIEW::TWO_POINT_ASSISTANT::ViewDraw().

GetConstantGlyphHeight()

KIGFX::PREVIEW::TEXT_DIMS KIGFX::PREVIEW::GetConstantGlyphHeight	(	KIGFX::GAL *	aGal,
		int	aRelativeSize = 0
	)

Set the GAL glyph height to a constant scaled value, so that it always looks the same on screen.

Parameters

aGal	the GAL to draw on.
aRelativeSize	similar to HTML font sizes; 0 will give a standard size while +1 etc. will give larger and -1 etc. will give smaller.

Returns

the text widths for the resulting glyph size.

Definition at line 65 of file preview_utils.cpp.

{
 constexpr double aspectRatio = 1.0;
 constexpr double hdpiSizes[] = { 8, 9, 11, 13, 15 };
 constexpr double sizes[] = { 10, 12, 14, 16, 18 };
 
 double height;
 double thicknessFactor;
 double shadowFactor;
 double linePitchFactor;
 
 HIDPI_GL_CANVAS* canvas = dynamic_cast<HIDPI_GL_CANVAS*>( aGal );
 
 if( canvas && canvas->GetScaleFactor() > 1 )
 {
 height = hdpiSizes[ 2 + aRelativeSize ];
 thicknessFactor = 0.15;
 shadowFactor = 0.10;
 linePitchFactor = 1.7;
 }
 else
 {
 height = sizes[ 2 + aRelativeSize ];
 thicknessFactor = 0.20;
 shadowFactor = 0.15;
 linePitchFactor = 1.9;
 }
 
 height /= aGal->GetWorldScale();
 
 TEXT_DIMS textDims;
 
 textDims.GlyphSize = VECTOR2I( height * aspectRatio, height );
 textDims.StrokeWidth = height * thicknessFactor;
 textDims.ShadowWidth = height * shadowFactor;
 textDims.LinePitch = height * linePitchFactor;
 
 return textDims;
}

References HIDPI_GL_CANVAS::GetScaleFactor(), KIGFX::GAL::GetWorldScale(), KIGFX::PREVIEW::TEXT_DIMS::GlyphSize, KIGFX::PREVIEW::TEXT_DIMS::LinePitch, KIGFX::PREVIEW::TEXT_DIMS::ShadowWidth, and KIGFX::PREVIEW::TEXT_DIMS::StrokeWidth.

Referenced by drawBacksideTicks(), DrawTextNextToCursor(), drawTicksAlongLine(), and KIGFX::PREVIEW::RULER_ITEM::ViewDraw().

GetShadowColor()

KIGFX::COLOR4D KIGFX::PREVIEW::GetShadowColor

(

const COLOR4D &

aColor

)

Definition at line 107 of file preview_utils.cpp.

{
 if( aColor.GetBrightness() > 0.5 )
 return COLOR4D::BLACK;
 else
 return COLOR4D::WHITE;
}

References BLACK, KIGFX::COLOR4D::GetBrightness(), and WHITE.

Referenced by DrawTextNextToCursor(), and KIGFX::PREVIEW::RULER_ITEM::ViewDraw().

PreviewOverlayDeemphAlpha()

double KIGFX::PREVIEW::PreviewOverlayDeemphAlpha

(

bool

aDeemph = true

)

Default alpha of "de-emphasised" features (like previously locked-in lines.

Definition at line 27 of file preview_utils.cpp.

{
 return aDeemph ? 0.5 : 1.0;
}

Referenced by deemphasise().