#include <pns_log_viewer_frame.h>

Inheritance diagram for PNS_LOG_VIEWER_OVERLAY:

Public Member Functions
	PNS_LOG_VIEWER_OVERLAY (KIGFX::GAL *aGal)

void	AnnotatedPolyline (const SHAPE_LINE_CHAIN &aL, std::string name, bool aShowVertexNumbers=false)

void	AnnotatedPoint (const VECTOR2I p, int size, std::string name="", bool aShowVertexNumbers=false)

void	Arc (const SHAPE_ARC &arc)

void	DrawAnnotations ()

void	Clear ()

virtual const BOX2I	ViewBBox () const override
	Return the bounding box of the item covering all its layers. More...

virtual void	ViewDraw (int aLayer, VIEW *aView) const override
	Draw the parts of the object belonging to layer aLayer. More...

virtual void	ViewGetLayers (int aLayers[], int &aCount) const override
	Return the all the layers within the VIEW the object is painted on. More...

void	Line (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)

void	Line (const SEG &aSeg)

void	Segment (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint, double aWidth)

void	Circle (const VECTOR2D &aCenterPoint, double aRadius)

void	Arc (const VECTOR2D &aCenterPoint, double aRadius, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aEndAngle)

void	Rectangle (const VECTOR2D &aStartPoint, const VECTOR2D &aEndPoint)

void	Cross (const VECTOR2D &aP, int aSize)

void	Polygon (const std::deque< VECTOR2D > &aPointList)

void	Polygon (const SHAPE_POLY_SET &aPolySet)

void	Polygon (const VECTOR2D aPointList[], int aListSize)

void	Polyline (const SHAPE_LINE_CHAIN &aPolyLine)

void	BitmapText (const wxString &aText, const VECTOR2I &aPosition, const EDA_ANGLE &aAngle)

void	SetIsFill (bool aIsFillEnabled)

void	SetIsStroke (bool aIsStrokeEnabled)

void	SetFillColor (const COLOR4D &aColor)

void	SetStrokeColor (const COLOR4D &aColor)

void	SetGlyphSize (const VECTOR2I &aSize)

void	SetLineWidth (double aLineWidth)

const COLOR4D &	GetStrokeColor () const

const COLOR4D &	GetFillColor () const

virtual double	ViewGetLOD (int aLayer, VIEW *aView) const
	Return the level of detail (LOD) of the item. More...

VIEW_ITEM_DATA *	viewPrivData () const

void	SetForcedTransparency (double aForcedTransparency)

double	GetForcedTransparency () const

bool	Set (PROPERTY_BASE *aProperty, wxAny &aValue)

template<typename T >
bool	Set (PROPERTY_BASE *aProperty, T aValue)

template<typename T >
bool	Set (const wxString &aProperty, T aValue)

wxAny	Get (PROPERTY_BASE *aProperty) const

template<typename T >
T	Get (PROPERTY_BASE *aProperty) const

template<typename T >
std::optional< T >	Get (const wxString &aProperty) const

Private Member Functions
void	releaseCommands ()

Private Attributes
std::unique_ptr< LABEL_MANAGER >	m_labelMgr

COLOR4D	m_strokeColor

COLOR4D	m_fillColor

std::vector< COMMAND * >	m_commands

VIEW_ITEM_DATA *	m_viewPrivData

double	m_forcedTransparency
	Additional transparency for diff'ing items. More...

Detailed Description

Definition at line 103 of file pns_log_viewer_frame.h.

Constructor & Destructor Documentation

◆ PNS_LOG_VIEWER_OVERLAY()

PNS_LOG_VIEWER_OVERLAY::PNS_LOG_VIEWER_OVERLAY ( KIGFX::GAL * aGal )

Definition at line 62 of file pns_log_viewer_frame.cpp.

References m_labelMgr.

Member Function Documentation

◆ AnnotatedPoint()

void PNS_LOG_VIEWER_OVERLAY::AnnotatedPoint	(	const VECTOR2I	p,
		int	size,
		std::string	name = `""`,
		bool	aShowVertexNumbers = `false`
	)

Definition at line 84 of file pns_log_viewer_frame.cpp.

References KIGFX::VIEW_OVERLAY::GetStrokeColor(), KIGFX::VIEW_OVERLAY::Line(), m_labelMgr, and name.

◆ AnnotatedPolyline()

void PNS_LOG_VIEWER_OVERLAY::AnnotatedPolyline	(	const SHAPE_LINE_CHAIN &	aL,
		std::string	name,
		bool	aShowVertexNumbers = `false`
	)

Definition at line 68 of file pns_log_viewer_frame.cpp.

References SHAPE_LINE_CHAIN::CPoint(), KIGFX::VIEW_OVERLAY::GetStrokeColor(), m_labelMgr, name, SHAPE_LINE_CHAIN::PointCount(), and KIGFX::VIEW_OVERLAY::Polyline().

◆ Arc() [1/2]

void PNS_LOG_VIEWER_OVERLAY::Arc ( const SHAPE_ARC & arc )

Definition at line 94 of file pns_log_viewer_frame.cpp.

References KIGFX::VIEW_OVERLAY::Arc(), SHAPE_ARC::GetCenter(), SHAPE_ARC::GetCentralAngle(), SHAPE_ARC::GetRadius(), SHAPE_ARC::GetStartAngle(), KIGFX::VIEW_OVERLAY::GetStrokeColor(), SHAPE_ARC::GetWidth(), KIGFX::VIEW_OVERLAY::SetLineWidth(), KIGFX::VIEW_OVERLAY::SetStrokeColor(), and KIGFX::COLOR4D::WithAlpha().

◆ Arc() [2/2]

void KIGFX::VIEW_OVERLAY::Arc	(	const VECTOR2D &	aCenterPoint,
		double	aRadius,
		const EDA_ANGLE &	aStartAngle,
		const EDA_ANGLE &	aEndAngle
	)

inherited

Definition at line 373 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

Referenced by Arc().

◆ BitmapText()

void KIGFX::VIEW_OVERLAY::BitmapText	(	const wxString &	aText,
		const VECTOR2I &	aPosition,
		const EDA_ANGLE &	aAngle
	)

inherited

Definition at line 398 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

Referenced by LABEL_MANAGER::Redraw().

◆ Circle()

void KIGFX::VIEW_OVERLAY::Circle	(	const VECTOR2D &	aCenterPoint,
		double	aRadius
	)

inherited

Definition at line 367 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

◆ Clear()

void KIGFX::VIEW_OVERLAY::Clear ( )

inherited

Definition at line 285 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::releaseCommands().

◆ Cross()

void KIGFX::VIEW_OVERLAY::Cross	(	const VECTOR2D &	aP,
		int	aSize
	)

inherited

Definition at line 429 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::Line().

◆ DrawAnnotations()

void PNS_LOG_VIEWER_OVERLAY::DrawAnnotations ( )

Definition at line 113 of file pns_log_viewer_frame.cpp.

References m_labelMgr.

◆ Get() [1/3]

template<typename T >

std::optional< T > INSPECTABLE::Get ( const wxString & aProperty ) const

inlineinherited

Definition at line 104 of file inspectable.h.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Get() [2/3]

wxAny INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 84 of file inspectable.h.

References PROPERTY_BASE::getter(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by BOOST_AUTO_TEST_CASE(), CLASS_D_DESC::CLASS_D_DESC(), EDA_SHAPE_DESC::EDA_SHAPE_DESC(), PROPERTIES_PANEL::getItemValue(), and PCBEXPR_VAR_REF::GetValue().

◆ Get() [3/3]

template<typename T >

T INSPECTABLE::Get ( PROPERTY_BASE * aProperty ) const

inlineinherited

Definition at line 92 of file inspectable.h.

References PROPERTY_BASE::get(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ GetFillColor()

const COLOR4D & KIGFX::VIEW_OVERLAY::GetFillColor ( ) const

inlineinherited

Definition at line 104 of file view_overlay.h.

References KIGFX::VIEW_OVERLAY::m_fillColor.

◆ GetForcedTransparency()

double KIGFX::VIEW_ITEM::GetForcedTransparency ( ) const

inlineinherited

Definition at line 150 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

Referenced by EDA_ITEM::EDA_ITEM(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), and EDA_ITEM::operator=().

◆ GetStrokeColor()

const COLOR4D & KIGFX::VIEW_OVERLAY::GetStrokeColor ( ) const

inlineinherited

Definition at line 103 of file view_overlay.h.

References KIGFX::VIEW_OVERLAY::m_strokeColor.

Referenced by AnnotatedPoint(), AnnotatedPolyline(), and Arc().

◆ Line() [1/2]

void KIGFX::VIEW_OVERLAY::Line ( const SEG & aSeg )

inherited

Definition at line 326 of file view_overlay.cpp.

References SEG::A, SEG::B, and KIGFX::VIEW_OVERLAY::Line().

◆ Line() [2/2]

void KIGFX::VIEW_OVERLAY::Line	(	const VECTOR2D &	aStartPoint,
		const VECTOR2D &	aEndPoint
	)

inherited

Definition at line 320 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

Referenced by AnnotatedPoint(), KIGFX::VIEW_OVERLAY::Cross(), KIGFX::VIEW_OVERLAY::Line(), KIGFX::VIEW_OVERLAY::Polyline(), LABEL_MANAGER::Redraw(), and KIGFX::VIEW_OVERLAY::Segment().

◆ Polygon() [1/3]

void KIGFX::VIEW_OVERLAY::Polygon ( const SHAPE_POLY_SET & aPolySet )

inherited

Definition at line 349 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

◆ Polygon() [2/3]

void KIGFX::VIEW_OVERLAY::Polygon ( const std::deque< VECTOR2D > & aPointList )

inherited

Definition at line 355 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

◆ Polygon() [3/3]

void KIGFX::VIEW_OVERLAY::Polygon	(	const VECTOR2D	aPointList[],
		int	aListSize
	)

inherited

Definition at line 361 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

◆ Polyline()

void KIGFX::VIEW_OVERLAY::Polyline ( const SHAPE_LINE_CHAIN & aPolyLine )

inherited

Definition at line 339 of file view_overlay.cpp.

References SHAPE_LINE_CHAIN::CSegment(), KIGFX::VIEW_OVERLAY::Line(), SHAPE_LINE_CHAIN::SegmentCount(), KIGFX::VIEW_OVERLAY::SetIsFill(), and KIGFX::VIEW_OVERLAY::SetIsStroke().

Referenced by AnnotatedPolyline().

◆ Rectangle()

void KIGFX::VIEW_OVERLAY::Rectangle	(	const VECTOR2D &	aStartPoint,
		const VECTOR2D &	aEndPoint
	)

inherited

Definition at line 380 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

Referenced by LABEL_MANAGER::Redraw().

◆ releaseCommands()

void KIGFX::VIEW_OVERLAY::releaseCommands ( )

privateinherited

Definition at line 276 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

Referenced by KIGFX::VIEW_OVERLAY::Clear(), and KIGFX::VIEW_OVERLAY::~VIEW_OVERLAY().

◆ Segment()

void KIGFX::VIEW_OVERLAY::Segment	(	const VECTOR2D &	aStartPoint,
		const VECTOR2D &	aEndPoint,
		double	aWidth
	)

inherited

Definition at line 332 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::Line(), and KIGFX::VIEW_OVERLAY::SetLineWidth().

◆ Set() [1/3]

template<typename T >

bool INSPECTABLE::Set	(	const wxString &	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 66 of file inspectable.h.

References PROPERTY_MANAGER::GetProperty(), PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [2/3]

template<typename T >

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		T	aValue
	)

inlineinherited

Definition at line 54 of file inspectable.h.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::set(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

◆ Set() [3/3]

bool INSPECTABLE::Set	(	PROPERTY_BASE *	aProperty,
		wxAny &	aValue
	)

inlineinherited

Definition at line 42 of file inspectable.h.

References PROPERTY_MANAGER::Instance(), PROPERTY_BASE::OwnerHash(), PROPERTY_BASE::setter(), TYPE_HASH, and PROPERTY_MANAGER::TypeCast().

Referenced by SCH_PROPERTIES_PANEL::valueChanged(), and PCB_PROPERTIES_PANEL::valueChanged().

◆ SetFillColor()

void KIGFX::VIEW_OVERLAY::SetFillColor ( const COLOR4D & aColor )

inherited

Definition at line 411 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands, and KIGFX::VIEW_OVERLAY::m_fillColor.

◆ SetForcedTransparency()

void KIGFX::VIEW_ITEM::SetForcedTransparency ( double aForcedTransparency )

inlineinherited

Definition at line 145 of file view_item.h.

References KIGFX::VIEW_ITEM::m_forcedTransparency.

Referenced by EDA_ITEM::EDA_ITEM(), SYMBOL_DIFF_WIDGET::onSlider(), FOOTPRINT_DIFF_WIDGET::onSlider(), and EDA_ITEM::operator=().

◆ SetGlyphSize()

void KIGFX::VIEW_OVERLAY::SetGlyphSize ( const VECTOR2I & aSize )

inherited

Definition at line 392 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

◆ SetIsFill()

void KIGFX::VIEW_OVERLAY::SetIsFill ( bool aIsFillEnabled )

inherited

Definition at line 386 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

Referenced by KIGFX::VIEW_OVERLAY::Polyline(), and LABEL_MANAGER::Redraw().

◆ SetIsStroke()

void KIGFX::VIEW_OVERLAY::SetIsStroke ( bool aIsStrokeEnabled )

inherited

Definition at line 405 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

Referenced by KIGFX::VIEW_OVERLAY::Polyline(), and LABEL_MANAGER::Redraw().

◆ SetLineWidth()

void KIGFX::VIEW_OVERLAY::SetLineWidth ( double aLineWidth )

inherited

Definition at line 424 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands.

Referenced by Arc(), LABEL_MANAGER::Redraw(), and KIGFX::VIEW_OVERLAY::Segment().

◆ SetStrokeColor()

void KIGFX::VIEW_OVERLAY::SetStrokeColor ( const COLOR4D & aColor )

inherited

Definition at line 418 of file view_overlay.cpp.

References KIGFX::VIEW_OVERLAY::m_commands, and KIGFX::VIEW_OVERLAY::m_strokeColor.

Referenced by Arc(), and LABEL_MANAGER::Redraw().

◆ ViewBBox()

const BOX2I KIGFX::VIEW_OVERLAY::ViewBBox ( ) const

overridevirtualinherited

Return the bounding box of the item covering all its layers.

Returns: the current bounding box.

Implements KIGFX::VIEW_ITEM.

Definition at line 291 of file view_overlay.cpp.

References BOX2< Vec >::SetMaximum().

◆ ViewDraw()

void KIGFX::VIEW_OVERLAY::ViewDraw	(	int	aLayer,
		VIEW *	aView
	)		const

overridevirtualinherited

Draw the parts of the object belonging to layer aLayer.

An alternative way for drawing objects if there is no #PAINTER assigned for the view or if the PAINTER doesn't know how to paint this particular implementation of VIEW_ITEM. The preferred way of drawing is to design an appropriate PAINTER object, the method below is intended only for quick hacks and debugging purposes.

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Reimplemented from KIGFX::VIEW_ITEM.

Definition at line 300 of file view_overlay.cpp.

References KIGFX::VIEW::GetGAL(), KIGFX::VIEW_OVERLAY::m_commands, and KIGFX::GAL::PushDepth().

◆ ViewGetLayers()

void KIGFX::VIEW_OVERLAY::ViewGetLayers	(	int	aLayers[],
		int &	aCount
	)		const

overridevirtualinherited

Return the all the layers within the VIEW the object is painted on.

For instance, a PAD spans zero or more copper layers and a few technical layers. ViewDraw() or PAINTER::Draw() is repeatedly called for each of the layers returned by ViewGetLayers(), depending on the rendering order.

Parameters

aLayers[]	is the output layer index array.
aCount	is the number of layer indices in aLayers[].

Implements KIGFX::VIEW_ITEM.

Definition at line 313 of file view_overlay.cpp.

References LAYER_GP_OVERLAY.

◆ ViewGetLOD()

virtual double KIGFX::VIEW_ITEM::ViewGetLOD	(	int	aLayer,
		VIEW *	aView
	)		const

inlinevirtualinherited

Return the level of detail (LOD) of the item.

A level of detail is the minimal VIEW scale that is sufficient for an item to be shown on a given layer.

Parameters

aLayer	is the current drawing layer.
aView	is a pointer to the VIEW device we are drawing on.

Returns: the level of detail. 0 always show the item, because the actual zoom level (or VIEW scale) is always > 0

Reimplemented in SCH_LINE, GERBER_DRAW_ITEM, PCB_GROUP, FOOTPRINT, PAD, PCB_BITMAP, PCB_FIELD, PCB_SHAPE, PCB_TEXT, PCB_TEXTBOX, PCB_TRACK, PCB_VIA, and ZONE.

Definition at line 134 of file view_item.h.

Referenced by PNS_KICAD_IFACE::IsItemVisible(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), EE_GRID_HELPER::queryVisible(), and PCB_GRID_HELPER::queryVisible().

◆ viewPrivData()

VIEW_ITEM_DATA * KIGFX::VIEW_ITEM::viewPrivData ( ) const

inlineinherited

Member Data Documentation

◆ m_commands

std::vector<COMMAND*> KIGFX::VIEW_OVERLAY::m_commands

privateinherited

Definition at line 112 of file view_overlay.h.

Referenced by KIGFX::VIEW_OVERLAY::Arc(), KIGFX::VIEW_OVERLAY::BitmapText(), KIGFX::VIEW_OVERLAY::Circle(), KIGFX::VIEW_OVERLAY::Line(), KIGFX::VIEW_OVERLAY::Polygon(), KIGFX::VIEW_OVERLAY::Rectangle(), KIGFX::VIEW_OVERLAY::releaseCommands(), KIGFX::VIEW_OVERLAY::SetFillColor(), KIGFX::VIEW_OVERLAY::SetGlyphSize(), KIGFX::VIEW_OVERLAY::SetIsFill(), KIGFX::VIEW_OVERLAY::SetIsStroke(), KIGFX::VIEW_OVERLAY::SetLineWidth(), KIGFX::VIEW_OVERLAY::SetStrokeColor(), and KIGFX::VIEW_OVERLAY::ViewDraw().

◆ m_fillColor

COLOR4D KIGFX::VIEW_OVERLAY::m_fillColor

privateinherited

Definition at line 110 of file view_overlay.h.

Referenced by KIGFX::VIEW_OVERLAY::GetFillColor(), and KIGFX::VIEW_OVERLAY::SetFillColor().

◆ m_forcedTransparency

double KIGFX::VIEW_ITEM::m_forcedTransparency

privateinherited

Additional transparency for diff'ing items.

Definition at line 159 of file view_item.h.

Referenced by KIGFX::VIEW_ITEM::GetForcedTransparency(), KIGFX::VIEW::DRAW_ITEM_VISITOR::operator()(), and KIGFX::VIEW_ITEM::SetForcedTransparency().

◆ m_labelMgr

std::unique_ptr<LABEL_MANAGER> PNS_LOG_VIEWER_OVERLAY::m_labelMgr

private

Definition at line 117 of file pns_log_viewer_frame.h.

Referenced by AnnotatedPoint(), AnnotatedPolyline(), DrawAnnotations(), and PNS_LOG_VIEWER_OVERLAY().

◆ m_strokeColor

COLOR4D KIGFX::VIEW_OVERLAY::m_strokeColor

privateinherited

Definition at line 109 of file view_overlay.h.

Referenced by KIGFX::VIEW_OVERLAY::GetStrokeColor(), and KIGFX::VIEW_OVERLAY::SetStrokeColor().

◆ m_viewPrivData

VIEW_ITEM_DATA* KIGFX::VIEW_ITEM::m_viewPrivData

privateinherited

Definition at line 158 of file view_item.h.

Referenced by KIGFX::VIEW::Add(), KIGFX::VIEW::OnDestroy(), KIGFX::VIEW::Remove(), KIGFX::VIEW_ITEM::viewPrivData(), and KIGFX::VIEW_ITEM::~VIEW_ITEM().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PNS_LOG_VIEWER_OVERLAY()

Member Function Documentation

◆ AnnotatedPoint()

◆ AnnotatedPolyline()

◆ Arc() [1/2]

◆ Arc() [2/2]

◆ BitmapText()

◆ Circle()

◆ Clear()

◆ Cross()

◆ DrawAnnotations()

◆ Get() [1/3]

◆ Get() [2/3]

◆ Get() [3/3]

◆ GetFillColor()

◆ GetForcedTransparency()

◆ GetStrokeColor()

◆ Line() [1/2]

◆ Line() [2/2]

◆ Polygon() [1/3]

◆ Polygon() [2/3]

◆ Polygon() [3/3]

◆ Polyline()

◆ Rectangle()

◆ releaseCommands()

◆ Segment()

◆ Set() [1/3]

◆ Set() [2/3]

◆ Set() [3/3]

◆ SetFillColor()

◆ SetForcedTransparency()

◆ SetGlyphSize()

◆ SetIsFill()

◆ SetIsStroke()

◆ SetLineWidth()

◆ SetStrokeColor()

◆ ViewBBox()

◆ ViewDraw()

◆ ViewGetLayers()

◆ ViewGetLOD()

◆ viewPrivData()

Member Data Documentation

◆ m_commands

◆ m_fillColor

◆ m_forcedTransparency

◆ m_labelMgr

◆ m_strokeColor

◆ m_viewPrivData