Marker are mainly used to show a DRC or ERC error or warning. More...

#include <marker_base.h>

Inheritance diagram for MARKER_BASE:

Public Types
enum	MARKER_T { MARKER_UNSPEC , MARKER_ERC , MARKER_DRC , MARKER_DRAWING_SHEET , MARKER_RATSNEST , MARKER_PARITY , MARKER_SIMUL }

Public Member Functions
	MARKER_BASE (int aScalingFactor, std::shared_ptr< RC_ITEM > aItem, MARKER_T aType=MARKER_UNSPEC)

virtual	~MARKER_BASE ()

int	MarkerScale () const
	The scaling factor to convert polygonal shape coordinates to internal units.

void	SetMarkerScale (int aScale)

void	ShapeToPolygon (SHAPE_LINE_CHAIN &aPolygon, int aScale=-1) const
	Return the shape polygon in internal units in a SHAPE_LINE_CHAIN the coordinates are relatives to the marker position (are not absolute).

const VECTOR2I &	GetPos () const

virtual const KIID	GetUUID () const =0

void	SetMarkerType (enum MARKER_T aMarkerType)
	Accessors to set/get marker type (DRC, ERC, or other)

enum MARKER_T	GetMarkerType () const

bool	IsExcluded () const

void	SetExcluded (bool aExcluded, const wxString &aComment=wxEmptyString)

wxString	GetComment () const

virtual SEVERITY	GetSeverity () const

std::shared_ptr< RC_ITEM >	GetRCItem () const

bool	HitTestMarker (const VECTOR2I &aHitPosition, int aAccuracy) const
	Test if the given VECTOR2I is within the bounds of this object.

bool	HitTestMarker (const BOX2I &aRect, bool aContained, int aAccuracy=0) const
	Test if the given BOX2I intersects or contains the bounds of this object.

BOX2I	GetBoundingBoxMarker () const
	Return the orthogonal, bounding box of this object for display purposes.

Public Attributes
VECTOR2I	m_Pos
	Position of the marker.

Protected Member Functions
virtual KIGFX::COLOR4D	getColor () const =0

Protected Attributes
MARKER_T	m_markerType
	The type of marker.

bool	m_excluded
	User has excluded this specific error.

wxString	m_comment
	User supplied comment.

std::shared_ptr< RC_ITEM >	m_rcItem

int	m_scalingFactor
	Scaling factor to convert corners coordinates to internal units coordinates.

BOX2I	m_shapeBoundingBox
	Bounding box of the graphic symbol relative to the position of the shape in marker shape units.

Detailed Description

Marker are mainly used to show a DRC or ERC error or warning.

Definition at line 48 of file marker_base.h.

Member Enumeration Documentation

◆ MARKER_T

enum MARKER_BASE::MARKER_T

Enumerator
MARKER_UNSPEC
MARKER_ERC
MARKER_DRC
MARKER_DRAWING_SHEET
MARKER_RATSNEST
MARKER_PARITY
MARKER_SIMUL

Definition at line 51 of file marker_base.h.

Constructor & Destructor Documentation

◆ MARKER_BASE()

MARKER_BASE::MARKER_BASE	(	int	aScalingFactor,
		std::shared_ptr< RC_ITEM >	aItem,
		MARKER_T	aType = `MARKER_UNSPEC`
	)

Definition at line 63 of file marker_base.cpp.

References CORNERS_COUNT, end, m_shapeBoundingBox, MarkerShapeCorners, BOX2< Vec >::SetEnd(), BOX2< Vec >::SetOrigin(), VECTOR2< T >::x, and VECTOR2< T >::y.

◆ ~MARKER_BASE()

virtual MARKER_BASE::~MARKER_BASE ( )

inlinevirtual

Definition at line 64 of file marker_base.h.

Member Function Documentation

◆ GetBoundingBoxMarker()

BOX2I MARKER_BASE::GetBoundingBoxMarker ( ) const

Return the orthogonal, bounding box of this object for display purposes.

This box should be an enclosing perimeter for visible components of this object, and the units should be in the pcb or schematic coordinate system. It is OK to overestimate the size by a few counts.

Definition at line 130 of file marker_base.cpp.

References BOX2< Vec >::GetPosition(), BOX2< Vec >::GetSize(), m_Pos, m_scalingFactor, and m_shapeBoundingBox.

Referenced by SCH_MARKER::GetBoundingBox(), PCB_MARKER::GetBoundingBox(), and HitTestMarker().