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...

#include <draw_context.h>

Public Member Functions
	DRAW_CONTEXT (KIGFX::VIEW &aView)

void	DrawRectangle (const VECTOR2I &aC1, const VECTOR2I &aC2, bool aDeEmphasised)
	Draw a rectangle on the current layer.

void	DrawCircle (const VECTOR2I &aOrigin, double aRad, bool aDeEmphasised)
	Draw a preview circle on the current layer.

void	DrawCircleDashed (const VECTOR2I &aOrigin, double aRad, double aStepAngle, double aFillAngle, bool aDeEmphasised)
	Draw a dashed preview circle on the current layer.

void	DrawEllipse (const VECTOR2I &aOrigin, double aA, double aB, EDA_ANGLE aRot, bool aDeEmphasised)
	Draw a preview ellipse on the current layer.

void	DrawEllipse (const ELLIPSE< int > &aEllipse, bool aDeEmphasised)

void	DrawLine (const VECTOR2I &aStart, const VECTOR2I &aEnd, bool aDeEmphasised)
	Draw a simple line on the current layer.

void	DrawLineDashed (const VECTOR2I &aStart, const VECTOR2I &aEn, int aDashStep, int aDashFill, bool aDeEmphasised)
	Draw a dashed line on the current layer.

void	DrawLineWithAngleHighlight (const VECTOR2I &aStart, const VECTOR2I &aEnd, bool aDeEmphasised)
	Draw a straight line on the current layer, with a special highlight when the line angle is a multiple of 45 degrees.

void	DrawArcWithAngleHighlight (const VECTOR2I &aOrigin, double aRad, double aStartAngle, double aEndAngle)
	Draw an arc on the current layer, with a special highlight when the line angle is a multiple of 45 degrees.

Private Member Functions
COLOR4D	getSpecialAngleColour () const
	The GAL to draw into.

Private Attributes
KIGFX::GAL &	m_gal

const KIGFX::RENDER_SETTINGS &	m_render_settings
	The current layer to draw onto.

GAL_LAYER_ID	m_currLayer

float	m_lineWidth
	The line width to use for items.

Detailed Description

A KIGFX::PREVIEW::DRAW_CONTEXT is a wrapper around a GAL and some other settings that makes it easy to draw preview items consistently.

This class provides some graphical items that are often used by preview items. Complex items can be composed from these.

Definition at line 41 of file draw_context.h.

Constructor & Destructor Documentation

◆ DRAW_CONTEXT()

DRAW_CONTEXT::DRAW_CONTEXT ( KIGFX::VIEW & aView )

Definition at line 44 of file draw_context.cpp.

References LAYER_AUX_ITEMS, m_currLayer, m_gal, m_lineWidth, and m_render_settings.

Member Function Documentation

◆ DrawArcWithAngleHighlight()

void KIGFX::PREVIEW::DRAW_CONTEXT::DrawArcWithAngleHighlight	(	const VECTOR2I &	aOrigin,
		double	aRad,
		double	aStartAngle,
		double	aEndAngle )

Draw an arc on the current layer, with a special highlight when the line angle is a multiple of 45 degrees.

Parameters

aOrigin	the arc centre.
aRad	the arc radius.
aStartAngle	the arc start angle.
aEndAngle	the arc end angle.

◆ DrawCircle()

void DRAW_CONTEXT::DrawCircle	(	const VECTOR2I &	aOrigin,
		double	aRad,
		bool	aDeEmphasised )

Draw a preview circle on the current layer.

Parameters

aOrigin	circle origin.
aRad	circle radius.
aDeEmphasised	draw the circle de-emphasized.

Definition at line 65 of file draw_context.cpp.

References deemphasise(), m_currLayer, m_gal, m_lineWidth, and m_render_settings.

Referenced by KIGFX::PREVIEW::ARC_ASSISTANT::ViewDraw().

◆ DrawCircleDashed()

void DRAW_CONTEXT::DrawCircleDashed	(	const VECTOR2I &	aOrigin,
		double	aRad,
		double	aStepAngle,
		double	aFillAngle,
		bool	aDeEmphasised )

Draw a dashed preview circle on the current layer.

Parameters

aOrigin	circle origin.
aRad	circle radius.
aStepAngle	dash step angle.
aFillAngle	dash fill angle.
aDeEmphasised	draw the circle de-emphasized.

Definition at line 77 of file draw_context.cpp.

References deemphasise(), DEGREES_T, m_currLayer, m_gal, m_lineWidth, and m_render_settings.

◆ DrawEllipse() [1/2]

void DRAW_CONTEXT::DrawEllipse	(	const ELLIPSE< int > &	aEllipse,
		bool	aDeEmphasised )

Definition at line 95 of file draw_context.cpp.

References ELLIPSE< NumericType >::Center, DrawEllipse(), ELLIPSE< NumericType >::MajorRadius, ELLIPSE< NumericType >::MinorRadius, and ELLIPSE< NumericType >::Rotation.

◆ DrawEllipse() [2/2]

void DRAW_CONTEXT::DrawEllipse	(	const VECTOR2I &	aOrigin,
		double	aA,
		double	aB,
		EDA_ANGLE	aRot,
		bool	aDeEmphasised )

Draw a preview ellipse on the current layer.

Definition at line 101 of file draw_context.cpp.

References deemphasise(), m_currLayer, m_gal, m_lineWidth, and m_render_settings.

Referenced by DrawEllipse(), and KIGFX::PREVIEW::ELLIPSE_ASSISTANT::ViewDraw().

◆ DrawLine()

void DRAW_CONTEXT::DrawLine	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		bool	aDeEmphasised )

Draw a simple line on the current layer.

Parameters

aStart	line start point.
aEnd	line end point.
aDeEmphasised	draw the line de-.

Definition at line 113 of file draw_context.cpp.

References deemphasise(), m_currLayer, m_gal, m_lineWidth, and m_render_settings.

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

◆ DrawLineDashed()

void DRAW_CONTEXT::DrawLineDashed	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aEn,
		int	aDashStep,
		int	aDashFill,
		bool	aDeEmphasised )

Draw a dashed line on the current layer.

Parameters

aStart	line start point.
aEnd	line end point.
aDashStep	dash step distance.
aDashFill	dash fill distance.
aDeEmphasised	draw the line de-emphasized.

Definition at line 124 of file draw_context.cpp.

References deemphasise(), delta, m_currLayer, m_gal, m_lineWidth, and m_render_settings.

Referenced by KIGFX::PREVIEW::BEZIER_ASSISTANT::ViewDraw(), and PCB_TUNING_PATTERN::ViewDraw().

◆ DrawLineWithAngleHighlight()

void DRAW_CONTEXT::DrawLineWithAngleHighlight	(	const VECTOR2I &	aStart,
		const VECTOR2I &	aEnd,
		bool	aDeEmphasised )

Draw a straight line on the current layer, with a special highlight when the line angle is a multiple of 45 degrees.

Parameters

aStart	line start point.
aEnd	line end point.
aDeEmphasised	draw the line de-emphasized.

Definition at line 146 of file draw_context.cpp.

References angleIsSpecial(), deemphasise(), getSpecialAngleColour(), m_currLayer, m_gal, m_lineWidth, and m_render_settings.

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

◆ DrawRectangle()

void DRAW_CONTEXT::DrawRectangle	(	const VECTOR2I &	aC1,
		const VECTOR2I &	aC2,
		bool	aDeEmphasised )

Draw a rectangle on the current layer.

Parameters

aC1	rectangle corner 1.
aC2	rectangle corner 2.

Definition at line 53 of file draw_context.cpp.

References deemphasise(), m_currLayer, m_gal, m_lineWidth, and m_render_settings.

Referenced by KIGFX::PREVIEW::ELLIPSE_ASSISTANT::ViewDraw().

◆ getSpecialAngleColour()

COLOR4D DRAW_CONTEXT::getSpecialAngleColour ( ) const

private

The GAL to draw into.

Returns: the colour to use for "special" angles.

Definition at line 162 of file draw_context.cpp.

References m_render_settings.

Referenced by DrawLineWithAngleHighlight().

Member Data Documentation

◆ m_currLayer

GAL_LAYER_ID KIGFX::PREVIEW::DRAW_CONTEXT::m_currLayer

private

Definition at line 138 of file draw_context.h.

Referenced by DRAW_CONTEXT(), DrawCircle(), DrawCircleDashed(), DrawEllipse(), DrawLine(), DrawLineDashed(), DrawLineWithAngleHighlight(), and DrawRectangle().

◆ m_gal

KIGFX::GAL& KIGFX::PREVIEW::DRAW_CONTEXT::m_gal

private

Definition at line 133 of file draw_context.h.

Referenced by DRAW_CONTEXT(), DrawCircle(), DrawCircleDashed(), DrawEllipse(), DrawLine(), DrawLineDashed(), DrawLineWithAngleHighlight(), and DrawRectangle().

◆ m_lineWidth

float KIGFX::PREVIEW::DRAW_CONTEXT::m_lineWidth

private

The line width to use for items.

Definition at line 141 of file draw_context.h.

Referenced by DRAW_CONTEXT(), DrawCircle(), DrawCircleDashed(), DrawEllipse(), DrawLine(), DrawLineDashed(), DrawLineWithAngleHighlight(), and DrawRectangle().

◆ m_render_settings

const KIGFX::RENDER_SETTINGS& KIGFX::PREVIEW::DRAW_CONTEXT::m_render_settings

private

The current layer to draw onto.

Definition at line 135 of file draw_context.h.

Referenced by DRAW_CONTEXT(), DrawCircle(), DrawCircleDashed(), DrawEllipse(), DrawLine(), DrawLineDashed(), DrawLineWithAngleHighlight(), DrawRectangle(), and getSpecialAngleColour().

The documentation for this class was generated from the following files:

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DRAW_CONTEXT()

Member Function Documentation

◆ DrawArcWithAngleHighlight()

◆ DrawCircle()

◆ DrawCircleDashed()

◆ DrawEllipse() [1/2]

◆ DrawEllipse() [2/2]

◆ DrawLine()

◆ DrawLineDashed()

◆ DrawLineWithAngleHighlight()

◆ DrawRectangle()

◆ getSpecialAngleColour()

Member Data Documentation

◆ m_currLayer

◆ m_gal

◆ m_lineWidth

◆ m_render_settings