KIGFX::PREVIEW Namespace Reference

Classes
class	ARC_ASSISTANT
	Class SELECTION_AREA. More...
class	ARC_GEOM_MANAGER
	Class ARC_GEOM_MANAGER. More...
class	CENTRELINE_RECT_ITEM
	Class CENTRELINE_RECT_ITEM. 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
	Class POLYGON_ITEM. More...
class	RULER_ITEM
	Class RULER_ITEM. More...
class	SELECTION_AREA
	Class SELECTION_AREA. 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...
class	TWO_POINT_GEOMETRY_MANAGER
	Class TWO_POINT_GEOMETRY_MANAGER. More...

Functions
COLOR4D	PreviewOverlayDefaultColor ()
	The default fill/stroke color of preview overlay items. More...
double	PreviewOverlayFillAlpha ()
	The default alpha of overlay fills. More...
double	PreviewOverlayDeemphAlpha (bool aDeemph=true)
	Default alpha of "de-emphasised" features (like previously locked-in lines. More...
COLOR4D	PreviewOverlaySpecialAngleColor ()
	The colour of "special" angle overlay features. More...
wxString	DimensionLabel (const wxString &prefix, double aVal, EDA_UNITS_T aUnits)
	Get a formatted string showing a dimension to a sane precision with an optional prefix and unit suffix. More...
void	SetConstantGlyphHeight (KIGFX::GAL &aGal, double aHeight)
	Set the GAL glyph height to a constant scaled value, so that it always looks the same on screen. More...
void	DrawTextNextToCursor (KIGFX::GAL &aGal, const VECTOR2D &aCursorPos, const VECTOR2D &aTextQuadrant, const std::vector< wxString > &aStrings)
	Draw strings next to the cursor. More...

Function Documentation

wxString KIGFX::PREVIEW::DimensionLabel	(	const wxString &	prefix,
		double	aVal,
		EDA_UNITS_T	aUnits
	)

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

Definition at line 109 of file preview_utils.cpp.

References formatPreviewDimension().

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

{
    wxString str;

    if( prefix.size() )
        str << prefix << ": ";

    str << formatPreviewDimension( aVal, aUnits );
    return str;
}

void KIGFX::PREVIEW::DrawTextNextToCursor	(	KIGFX::GAL &	aGal,
		const VECTOR2D &	aCursorPos,
		const VECTOR2D &	aTextQuadrant,
		const std::vector< wxString > &	aStrings
	)

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 132 of file preview_utils.cpp.

References KIGFX::GAL::BitmapText(), KIGFX::GAL::GetGlyphSize(), KIGFX::GAL::GetWorldScale(), GR_TEXT_HJUSTIFY_LEFT, GR_TEXT_HJUSTIFY_RIGHT, PreviewOverlayDeemphAlpha(), PreviewOverlayDefaultColor(), KIGFX::GAL::SetHorizontalJustify(), KIGFX::GAL::SetIsFill(), KIGFX::GAL::SetStrokeColor(), VECTOR2< T >::x, and VECTOR2< T >::y.

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

{
    auto glyphSize = aGal.GetGlyphSize();

    const auto lineSpace = glyphSize.y * 0.2;
    auto linePitch = glyphSize.y + lineSpace;

    // 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)
    auto textPos = aCursorPos;

    // if the text goes above the cursor, shift it up
    if( aTextQuadrant.y > 0 )
    {
        textPos.y -= linePitch * ( aStrings.size() + 1 );
    }

    if( aTextQuadrant.x < 0 )
    {
        aGal.SetHorizontalJustify( GR_TEXT_HJUSTIFY_LEFT );
        textPos.x += 15.0 / aGal.GetWorldScale();
    }
    else
    {
        aGal.SetHorizontalJustify( GR_TEXT_HJUSTIFY_RIGHT );
        textPos.x -= 15.0 / aGal.GetWorldScale();
    }

    aGal.SetStrokeColor( PreviewOverlayDefaultColor().WithAlpha(
                            PreviewOverlayDeemphAlpha( true ) ) );
    aGal.SetIsFill( false );

    // write strings top-to-bottom
    for( const auto& str : aStrings )
    {
        textPos.y += linePitch;
        aGal.BitmapText( str, textPos, 0.0 );
    }
}

double KIGFX::PREVIEW::PreviewOverlayDeemphAlpha

(

bool

aDeemph = true

)

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

Definition at line 41 of file preview_utils.cpp.

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

{
    return aDeemph ? 0.5 : 1.0;
}

COLOR4D KIGFX::PREVIEW::PreviewOverlayDefaultColor

(

)

The default fill/stroke color of preview overlay items.

Definition at line 29 of file preview_utils.cpp.

Referenced by drawArcWithHilight(), drawLineWithHilight(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), DrawTextNextToCursor(), drawTicksAlongLine(), KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw(), and KIGFX::PREVIEW::RULER_ITEM::ViewDraw().

{
    return COLOR4D( 1.0, 1.0, 1.0, 1.0 );
}

double KIGFX::PREVIEW::PreviewOverlayFillAlpha

(

)

The default alpha of overlay fills.

Definition at line 35 of file preview_utils.cpp.

{
    return 0.2;
}

COLOR4D KIGFX::PREVIEW::PreviewOverlaySpecialAngleColor

(

)

The colour of "special" angle overlay features.

Definition at line 47 of file preview_utils.cpp.

Referenced by drawArcWithHilight(), and drawLineWithHilight().

{
    return COLOR4D( 0.5, 1.0, 0.5, 1.0 );
}

void KIGFX::PREVIEW::SetConstantGlyphHeight	(	KIGFX::GAL &	aGal,
		double	aHeight
	)

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
aHeight	the height of the glyph, in pixels

Definition at line 122 of file preview_utils.cpp.

References KIGFX::GAL::GetGlyphSize(), KIGFX::GAL::GetWorldScale(), and KIGFX::GAL::SetGlyphSize().

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

{
    aHeight /= aGal.GetWorldScale();

    auto glyphSize = aGal.GetGlyphSize();
    glyphSize = glyphSize * ( aHeight / glyphSize.y );
    aGal.SetGlyphSize( glyphSize );
}